System Administration Guide: Solaris Printing

IPP Operation Keywords

IPP objects support operations. An operation consists of a request and a response. When a print client communicates with an IPP object, the client issues an operation request to the URI for that object. Operation requests and responses have parameters that identify the operation. Operations also have attributes that affect the run time characteristics of the operation. These operation-specific attributes are defined as operation attributes. Print requests contain operation attributes, object attributes, and the required document data to perform the specific operation. Each request requires a response from the object. Each response indicates success or failure of the operation with a corresponding status code as a response parameter. Responses contain operation attributes, object attributes, and status messages that are generated during the operation request.

The following table describes the IPP operation keywords for the Apache Web Server Configuration.

Table A–4 IPP Operation Keywords

Value

Meaning

All

This keyword is used in place of an operation. The keyword is meant to signify that all operations that are supported by mod_ipp are selected.

Required

This keyword is used in place of an operation. The keyword is meant to signify that all the required operations, as defined in RFC-2911, are selected, including the following: print-job, cancel-job, get-job-attributes, get-jobs, and get-printer-attributes.

Print-job

A client wants to submit a print job with only a single document. The document data is sent with the request. 

Print-uri

Unsupported 

Validate-job

A client wants to validate that a print job can be handled by the scheduler before submitting a print job. 

Create-job

A client wants to submit a print job with multiple documents. The documents are sent with the send-document and send-uri operations.

Send-document

A client wants to add a document to a print job that is created with the print-job operation. The document data is sent with the request.

Send-uri

Unsupported 

Cancel-job

A client wants to cancel a print job. 

Get-job-attributes

A client wants to gather information about a print job. 

Get-jobs

A client wants to gather a list of print jobs in a particular print queue. 

Get-printer-attributes

A client wants to gather information about a particular print queue. 

Hold-job

A client wants to hold a particular print job. 

Release-job

A client wants to release a particular print job. 

Restart-job

A client wants to restart a particular print  

Pause-printer

A client wants to pause (disable) a particular print queue. This operation will stop the processing of print requests in the queue. Note that the operation does not stop the queue from accepting jobs. 

Resume-printer

A client wants to resume (enable) processing of jobs in a particular print queue. 

Purge-jobs

A client wants to remove all jobs from a particular print queue. 

Set-printer-attributes

Create or modify attributes of a printer. 

Set-job-attributes

Modify attributes of an existing print job. 

Enable-printer

Resume (accept) queueing of print jobs. 

Disable-printer

Disable (reject) queueing of print jobs. 

cups-get-default

Retrieve the default destination for a print service. 

cups-get-printers

Enumerate all printers available from the print service. 

cups-get-classes

Enumerate all classes available from the print service. 

cups-accept-jobs

CUPS specific equivalent of Enable-printer. 

cups-reject-jobs

CUPS specific equivalent of Disable-printer. 

cups-move-jobs

Move jobs between queues in the same print service.