File Formats mod_ipp(4)
NAME
mod_ipp - Embedded Internet Print Protocol (IPP) listener
for the Apache HTTP serverSYNOPSIS
/usr/apache/libexec/mod_ipp.so
DESCRIPTION
The mod_ipp module implements RFCs 2910 and 2911 to provide
an IPP handling service for the Apache HTTP server. Whenloaded on the Apache server, mod_ipp processes all HTTP
requests with MIME types of application/ipp. The mod_ipp
module also processes additional configuration directives to enable or disable portions of the protocol support. Using Configuration Directives The following is a list of configuration directives that apply to the Apache IPP Listening service:o ipp-conformance (automatic|1.0|1.1)
o ipp-operation (operation) (enable|disable)
o enable|disable The values true, yes, on, enable are considered to be synonymous and will enable support forthe named operation. All other values will dis-
able support for the named operation. Operations The following is a list of IPP handling service operations:print-job This operation is a required IPP
operation that allows client sys-
tems to submit a print job with a single document embedded in the data stream. This operation isprimarily used from the IPP sup-
port Microsoft has provided forits Windows (9X/ME/NT/2K/XP).
print-uri This is an optional IPP operation
that allows client systems to sub-
mit a print job with a reference (URL) for a single document. Thisoperation is currently not sup-
ported by the mod_ipp Apache
Module.SunOS 5.11 Last change: 26 Nov 2003 1
File Formats mod_ipp(4)
validate-job This is a required IPP operation
that allows client systems to simulate the submission of a print job to verify that the server is capable of handling the job. Thisoperation is supported by mod_ipp.
create-job This is an optional IPP operation
that allows client systems to sub-
mit a print job. The operation isused with the send-document and
send-uri operations.
get-jobs This is a required IPP operation
that allows client systems to retrieve a list of print jobs from the print service.get-printer-attributes This is a required IPP operation
that allows client systems to retrieve attributes from the print service that describes the named printer object.pause-printer This an optional IPP operation
that allows client systems to stop job processing on the named print queue.resume-printer This is an optional IPP operation
that allows client systems to resume job processing on the named print queue.purge-jobs This is an optional IPP operation
that allows client systems to can-
cel all print jobs on the named print queue.send-document This is a required IPP operation
that allows client systems to add documents to print jobs createdwith the create-job operation, but
not yet submitted.SunOS 5.11 Last change: 26 Nov 2003 2
File Formats mod_ipp(4)
send-uri This is an optional IPP operation
that allows a client system to add a document reference (URI) to a print job created with thecreate-job operation, but not yet
submitted. This operation is currently not supported by themod_ipp Apache Module.
cancel-job This is a required IPP operation
that allows client systems to can-
cel print jobs.get-job-attributes This is a required IPP operation
that allows client systems to retrieve attributes that describea print job from the print ser-
vice.hold-job This is an optional IPP operation
that allows client systems to hold print jobs.release-job This is an optional IPP operation
that allows client systems to release print jobs.restart-job This is an optional IPP operation
that allows client systems to res-
tart print jobs.all This is a place holder for ena-
bling or disabling support for all IPP operations implemented by themod_ipp Apache module.
required This is a place holder for ena-
bling or disabling support for therequired IPP operations imple-
mented by the mod_ipp Apache
module.EXAMPLES
SunOS 5.11 Last change: 26 Nov 2003 3
File Formats mod_ipp(4)
Example 1 Using a Configuration File to Start a Standalone Apache Server The following configuration file can be used to start a standalone Apache server to respond to IPP request sent to port 631. ServerType standalone ServerRoot "/usr/apache"PidFile /var/run/httpd-standalone-ipp.pid
ErrorLog /var/lp/logs/ipp-errors
Timeout 300 KeepAlive On MaxKeepAliveRequests 100 KeepAliveTimeout 15 MinSpareServers 1 MaxSpareServers 3 StartServers 1 MaxClients 150 MaxRequestsPerChild 0LoadModule ipp_module libexec/mod_ipp.so
ClearModuleListAddModule mod_ipp.c
AddModule mod_so.c
Port 631 User lp Group lp ServerAdmin lp@localhost DefaultType application/ipp
ipp-operation all on
A more restrictive configuration might include the following parameters:
SunOS 5.11 Last change: 26 Nov 2003 4
File Formats mod_ipp(4)
ipp-operation all offn
ipp-operation required on
ATTRIBUTES
See attributes(5) or descriptions of the following attri-
butes:____________________________________________________________
| ATTRIBUTE TYPE | ATTRIBUTE VALUE |
|_____________________________|_____________________________|
| Availability | print/lp/ipp/ipp-listener |
|_____________________________|_____________________________|
| Interface Stability | Volatile ||_____________________________|_____________________________|
SEE ALSO
man(1), catman(1M), attributes(5) Herriot, R., Ed., Butler, S., Moore, P., Turner, R., Wenn, J. RFC 2910, Internet Printing Protocol/1.1: Encoding and Transport. Network Working Group. September 2000. Hastings, T., Ed., Herriot, R., deBry, R., Isaacson, S., Powell, P. RFC 2911, Internet Printing Protocol/1.1: Model and Semantics. Network Working Group. September 2000. http://www.apache.org NOTES Configuration file directives are processed in the order listed in the config file. The default behavior is to enablesupport for all operations implemented in the mod_ipp Apache
module.Since the Apache IPP listening service implements some capa-
bilities that are more of operator features, it may not be desirable to enable all IPP operations without requiring user authentication on the Apache listening service.SunOS 5.11 Last change: 26 Nov 2003 5
File Formats mod_ipp(4)
The following is an example of a more reasonable configura-
tion for Apache IPP servers without user authentication enabled:ipp-operations all disabled
ipp-operations required enabled
The printers and jobs available under this service can be accessed using URIs of the following form: printer: http://server[:port]/printers/{queue} ipp://server[:port]/printers/{queue} job:http://server[:port]/printers/{queue}/{job-id}
ipp://server[:port]/printers/{queue}/{job-id}
631 is the default IPP port and implied when the URI schemeis ipp. However, some client implementations do not recog-
nize the ipp URI scheme and require http://server:631/... instead. For example, Microsoft's IPP client implementation does not recognize the ipp scheme. In addition to the documentation and man pages included with Solaris, more information is available at http://www.apache.orgThe httpd(8) man page and other Apache man pages are pro-
vided with the programming modules. To view the Apache manual pages with the man command, add /usr/apache/man to the MANPATH environment variable. See man(1) for more information. Running catman(1M) on the Apache manual pages is not supported.SunOS 5.11 Last change: 26 Nov 2003 6