<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>cups.Connection</title>
<link rel="stylesheet" href="epydoc.css" type="text/css" />
<script type="text/javascript" src="epydoc.js"></script>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th> <a
href="cups-module.html">Home</a> </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<th class="navbar" width="100%"></th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<span class="breadcrumbs">
<a href="cups-module.html">Module cups</a> ::
Class Connection
</span>
</td>
<td>
<table cellpadding="0" cellspacing="0">
<!-- hide/show private -->
<tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
onclick="toggle_private();">hide private</a>]</span></td></tr>
<tr><td align="right"><span class="options"
>[<a href="frames.html" target="_top">frames</a
>] | <a href="cups.Connection-class.html"
target="_top">no frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class Connection</h1><p class="nomargin-top"></p>
<pre class="base-tree">
object --+
|
<strong class="uidshort">Connection</strong>
</pre>
<hr />
<h1 class="heading">CUPS connection</h1>
<p>A connection to the CUPS server. Before it is created the
connection server and username should be set using <a
href="cups-module.html#setServer" class="link">cups.setServer</a> and
<a href="cups-module.html#setUser" class="link">cups.setUser</a>;
otherwise the defaults will be used. When a Connection object is
instantiated it results in a call to the libcups function
httpConnectEncrypt().</p>
<p>The constructor takes optional arguments host, port, and encryption,
which default to the values of <a href="cups-module.html#getServer"
class="link">cups.getServer</a>(), <a href="cups-module.html#getPort"
class="link">cups.getPort</a>(), and <a
href="cups-module.html#getEncryption"
class="link">cups.getEncryption</a>().</p>
<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Instance Methods</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-InstanceMethods"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="cups.Connection-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">...</span>)</span><br />
x.__init__(...) initializes x; see x.__class__.__doc__ for signature</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">a new object with type S, a subtype of T</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="cups.Connection-class.html#__new__" class="summary-sig-name">__new__</a>(<span class="summary-sig-arg">T</span>,
<span class="summary-sig-arg">S</span>,
<span class="summary-sig-arg">...</span>)</span></td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="cups.Connection-class.html#__repr__" class="summary-sig-name">__repr__</a>(<span class="summary-sig-arg">x</span>)</span><br />
repr(x)</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">None</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="cups.Connection-class.html#acceptJobs" class="summary-sig-name">acceptJobs</a>(<span class="summary-sig-arg">name</span>)</span><br />
Cause printer to accept jobs.</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">None</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="cups.Connection-class.html#addPrinter" class="summary-sig-name">addPrinter</a>(<span class="summary-sig-arg">name</span>)</span><br />
Add or adjust a print queue.</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">None</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="cups.Connection-class.html#addPrinterOptionDefault" class="summary-sig-name">addPrinterOptionDefault</a>(<span class="summary-sig-arg">name</span>,
<span class="summary-sig-arg">option</span>,
<span class="summary-sig-arg">value</span>)</span><br />
Set a network default option.</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">None</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="cups.Connection-class.html#addPrinterToClass" class="summary-sig-name">addPrinterToClass</a>(<span class="summary-sig-arg">name</span>,
<span class="summary-sig-arg">class</span>)</span><br />
Add a printer to a class.</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">dict</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="cups.Connection-class.html#adminGetServerSettings" class="summary-sig-name">adminGetServerSettings</a>()</span><br />
Get server settings.</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">None</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="cups.Connection-class.html#adminSetServerSettings" class="summary-sig-name">adminSetServerSettings</a>(<span class="summary-sig-arg">settings</span>)</span><br />
Set server settings.</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">None</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="cups.Connection-class.html#authenticateJob" class="summary-sig-name">authenticateJob</a>(<span class="summary-sig-arg">jobid</span>,
<span class="summary-sig-arg">auth_info</span>=<span class="summary-sig-default">None</span>)</span></td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">None</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="cups.Connection-class.html#cancelAllJobs" class="summary-sig-name">cancelAllJobs</a>(<span class="summary-sig-arg">uri</span>,
<span class="summary-sig-arg">my_jobs</span>=<span class="summary-sig-default">False</span>,
<span class="summary-sig-arg">purge_jobs</span>=<span class="summary-sig-default">True</span>)</span></td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">None</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="cups.Connection-class.html#cancelJob" class="summary-sig-name">cancelJob</a>(<span class="summary-sig-arg">jobid</span>,
<span class="summary-sig-arg">purge_job</span>=<span class="summary-sig-default">False</span>)</span></td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">None</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="cups.Connection-class.html#cancelSubscription" class="summary-sig-name">cancelSubscription</a>(<span class="summary-sig-arg">id</span>)</span><br />
Cancel a subscription.</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="cups.Connection-class.html#createSubscription" class="summary-sig-name">createSubscription</a>(<span class="summary-sig-arg">...</span>)</span><br />
createSubscription(uri, events=[], job_id=-1, recipient_uri=,
lease_duration=-1, time_interval=-1,
user_data=) -> integer</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">None</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="cups.Connection-class.html#deleteClass" class="summary-sig-name">deleteClass</a>(<span class="summary-sig-arg">class</span>)</span><br />
Delete a class.</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">None</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="cups.Connection-class.html#deletePrinter" class="summary-sig-name">deletePrinter</a>(<span class="summary-sig-arg">name</span>)</span><br />
Delete a printer.</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">None</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="cups.Connection-class.html#deletePrinterFromClass" class="summary-sig-name">deletePrinterFromClass</a>(<span class="summary-sig-arg">name</span>,
<span class="summary-sig-arg">class</span>)</span><br />
Remove a printer from a class.</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">None</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="cups.Connection-class.html#deletePrinterOptionDefault" class="summary-sig-name">deletePrinterOptionDefault</a>(<span class="summary-sig-arg">name</span>,
<span class="summary-sig-arg">option</span>)</span><br />
Removes a network default option.</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">None</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="cups.Connection-class.html#disablePrinter" class="summary-sig-name">disablePrinter</a>(<span class="summary-sig-arg">name</span>)</span><br />
Disable printer.</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">None</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="cups.Connection-class.html#enablePrinter" class="summary-sig-name">enablePrinter</a>(<span class="summary-sig-arg">name</span>)</span><br />
Enable printer.</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">dict</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="cups.Connection-class.html#getClasses" class="summary-sig-name">getClasses</a>()</span><br />
Returns:
a dict, indexed by name, of objects representing classes.</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">string or None</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="cups.Connection-class.html#getDefault" class="summary-sig-name">getDefault</a>()</span><br />
Get the system default printer.</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">dict</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="cups.Connection-class.html#getDests" class="summary-sig-name">getDests</a>()</span><br />
Returns:
a dict representing available destinations.</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">dict</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="cups.Connection-class.html#getDevices" class="summary-sig-name">getDevices</a>(<span class="summary-sig-arg">limit</span>=<span class="summary-sig-default">0</span>,
<span class="summary-sig-arg">exclude_schemes</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">include_schemes</span>=<span class="summary-sig-default">None</span>)</span><br />
Returns:
a dict, indexed by device URI, of dicts representing devices, indexed
by attribute.</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">dict</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="cups.Connection-class.html#getDocument" class="summary-sig-name">getDocument</a>(<span class="summary-sig-arg">printer_uri</span>,
<span class="summary-sig-arg">job_id</span>,
<span class="summary-sig-arg">document_number</span>)</span><br />
Fetches the job document and stores it in a temporary file.</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">None</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="cups.Connection-class.html#getFile" class="summary-sig-name">getFile</a>(<span class="summary-sig-arg">resource</span>,
<span class="summary-sig-arg">filename</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">fd</span>=<span class="summary-sig-default">-1</span>,
<span class="summary-sig-arg">file</span>=<span class="summary-sig-default">None</span>)</span><br />
Fetch a CUPS server resource to a local file.</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">dict</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="cups.Connection-class.html#getJobAttributes" class="summary-sig-name">getJobAttributes</a>(<span class="summary-sig-arg">jobid</span>,
<span class="summary-sig-arg">requested_attributes</span>=<span class="summary-sig-default">None</span>)</span><br />
Fetch job attributes.</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">dict</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="cups.Connection-class.html#getJobs" class="summary-sig-name">getJobs</a>(<span class="summary-sig-arg">which_jobs</span>=<span class="summary-sig-default">'not-completed'</span>,
<span class="summary-sig-arg">my_jobs</span>=<span class="summary-sig-default">False</span>,
<span class="summary-sig-arg">limit</span>=<span class="summary-sig-default">-1</span>,
<span class="summary-sig-arg">first_job_id</span>=<span class="summary-sig-default">-1</span>,
<span class="summary-sig-arg">requested_attributes</span>=<span class="summary-sig-default">None</span>)</span><br />
Fetch a list of jobs.</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">list</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="cups.Connection-class.html#getNotifications" class="summary-sig-name">getNotifications</a>(<span class="summary-sig-arg">subscription_ids</span>)</span><br />
Get notifications for subscribed events.</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">string</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="cups.Connection-class.html#getPPD" class="summary-sig-name">getPPD</a>(<span class="summary-sig-arg">name</span>)</span><br />
Fetch a printer's PPD.</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">(status,modtime,filename)</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="cups.Connection-class.html#getPPD3" class="summary-sig-name">getPPD3</a>(<span class="summary-sig-arg">name</span>,
<span class="summary-sig-arg">modtime</span>=<span class="summary-sig-default">...</span>,
<span class="summary-sig-arg">filename</span>=<span class="summary-sig-default">...</span>)</span><br />
Fetch a printer's PPD if it is newer.</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">dict</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="cups.Connection-class.html#getPPDs" class="summary-sig-name">getPPDs</a>(<span class="summary-sig-arg">limit</span>=<span class="summary-sig-default">0</span>,
<span class="summary-sig-arg">exclude_schemes</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">include_schemes</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">ppd_natural_language</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">ppd_device_id</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">ppd_make</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">ppd_make_and_model</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">ppd_model_number</span>=<span class="summary-sig-default">-1</span>,
<span class="summary-sig-arg">ppd_product</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">ppd_psversion</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">ppd_type</span>=<span class="summary-sig-default">None</span>)</span><br />
Returns:
a dict, indexed by PPD name, of dicts representing PPDs, indexed by
attribute.</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">dict</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="cups.Connection-class.html#getPPDs2" class="summary-sig-name">getPPDs2</a>(<span class="summary-sig-arg">limit</span>=<span class="summary-sig-default">0</span>,
<span class="summary-sig-arg">exclude_schemes</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">include_schemes</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">ppd_natural_language</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">ppd_device_id</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">ppd_make</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">ppd_make_and_model</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">ppd_model_number</span>=<span class="summary-sig-default">-1</span>,
<span class="summary-sig-arg">ppd_product</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">ppd_psversion</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">ppd_type</span>=<span class="summary-sig-default">None</span>)</span><br />
Returns:
a dict, indexed by PPD name, of dicts representing PPDs, indexed by
attribute.</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">dict</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="cups.Connection-class.html#getPrinterAttributes" class="summary-sig-name">getPrinterAttributes</a>(<span class="summary-sig-arg">name</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">uri</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">requested_attributes</span>=<span class="summary-sig-default">None</span>)</span><br />
Fetch the attributes for a printer, specified either by name or by
uri but not both.</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">dict</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="cups.Connection-class.html#getPrinters" class="summary-sig-name">getPrinters</a>()</span><br />
Returns:
a dict, indexed by name, of dicts representing queues, indexed by
attribute.</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">string</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="cups.Connection-class.html#getServerPPD" class="summary-sig-name">getServerPPD</a>(<span class="summary-sig-arg">ppd_name</span>)</span><br />
Fetches the named PPD and stores it in a temporary file.</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">integer list</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="cups.Connection-class.html#getSubscriptions" class="summary-sig-name">getSubscriptions</a>(<span class="summary-sig-arg">uri</span>)</span><br />
Get subscriptions.</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">None</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="cups.Connection-class.html#moveJob" class="summary-sig-name">moveJob</a>(<span class="summary-sig-arg">printer_uri</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">job_id</span>=<span class="summary-sig-default">-1</span>,
<span class="summary-sig-arg">job_printer_uri</span>)</span><br />
Move a job specified by printer_uri and jobid (only one need be
given) to the printer specified by job_printer_uri.</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">integer</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="cups.Connection-class.html#printFile" class="summary-sig-name">printFile</a>(<span class="summary-sig-arg">printer</span>,
<span class="summary-sig-arg">filename</span>,
<span class="summary-sig-arg">title</span>,
<span class="summary-sig-arg">options</span>)</span><br />
Print a file.</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">integer</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="cups.Connection-class.html#printFiles" class="summary-sig-name">printFiles</a>(<span class="summary-sig-arg">printer</span>,
<span class="summary-sig-arg">filenames</span>,
<span class="summary-sig-arg">title</span>,
<span class="summary-sig-arg">options</span>)</span><br />
Print a list of files.</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">job ID</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="cups.Connection-class.html#printTestPage" class="summary-sig-name">printTestPage</a>(<span class="summary-sig-arg">name</span>)</span><br />
Print a test page.</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">None</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="cups.Connection-class.html#putFile" class="summary-sig-name">putFile</a>(<span class="summary-sig-arg">resource</span>,
<span class="summary-sig-arg">filename</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">fd</span>=<span class="summary-sig-default">-1</span>,
<span class="summary-sig-arg">file</span>=<span class="summary-sig-default">None</span>)</span><br />
This is for uploading new configuration files for the CUPS server.</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="cups.Connection-class.html#rejectJobs" class="summary-sig-name">rejectJobs</a>(<span class="summary-sig-arg">name</span>)</span><br />
Cause printer to reject jobs.</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">None</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="cups.Connection-class.html#renewSubscription" class="summary-sig-name">renewSubscription</a>(<span class="summary-sig-arg">id</span>,
<span class="summary-sig-arg">lease_duration</span>=<span class="summary-sig-default">-1</span>)</span><br />
Renew a subscription.</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">None</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="cups.Connection-class.html#restartJob" class="summary-sig-name">restartJob</a>(<span class="summary-sig-arg">job_id</span>,
<span class="summary-sig-arg">job_hold_until</span>=<span class="summary-sig-default">None</span>)</span><br />
Restart a job.</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">None</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="cups.Connection-class.html#setDefault" class="summary-sig-name">setDefault</a>(<span class="summary-sig-arg">name</span>)</span><br />
Set the system default printer.</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">None</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="cups.Connection-class.html#setJobHoldUntil" class="summary-sig-name">setJobHoldUntil</a>(<span class="summary-sig-arg">jobid</span>,
<span class="summary-sig-arg">job_hold_until</span>)</span><br />
Specifies when a job should be printed.</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">None</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="cups.Connection-class.html#setPrinterDevice" class="summary-sig-name">setPrinterDevice</a>(<span class="summary-sig-arg">name</span>,
<span class="summary-sig-arg">device_uri</span>)</span><br />
Set the device URI for a printer.</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">None</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="cups.Connection-class.html#setPrinterErrorPolicy" class="summary-sig-name">setPrinterErrorPolicy</a>(<span class="summary-sig-arg">name</span>,
<span class="summary-sig-arg">policy</span>)</span><br />
Set the printer's error policy.</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">None</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="cups.Connection-class.html#setPrinterInfo" class="summary-sig-name">setPrinterInfo</a>(<span class="summary-sig-arg">name</span>,
<span class="summary-sig-arg">info</span>)</span><br />
Set the human-readable information about a printer.</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">None</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="cups.Connection-class.html#setPrinterJobSheets" class="summary-sig-name">setPrinterJobSheets</a>(<span class="summary-sig-arg">name</span>,
<span class="summary-sig-arg">start</span>,
<span class="summary-sig-arg">end</span>)</span><br />
Specifies job sheets for a printer.</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">None</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="cups.Connection-class.html#setPrinterLocation" class="summary-sig-name">setPrinterLocation</a>(<span class="summary-sig-arg">name</span>,
<span class="summary-sig-arg">location</span>)</span><br />
Set the human-readable printer location</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">None</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="cups.Connection-class.html#setPrinterOpPolicy" class="summary-sig-name">setPrinterOpPolicy</a>(<span class="summary-sig-arg">name</span>,
<span class="summary-sig-arg">policy</span>)</span><br />
Set the printer's operation policy.</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">None</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="cups.Connection-class.html#setPrinterShared" class="summary-sig-name">setPrinterShared</a>(<span class="summary-sig-arg">name</span>,
<span class="summary-sig-arg">shared</span>)</span><br />
Set whether a printer is shared with other people.</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">None</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="cups.Connection-class.html#setPrinterUsersAllowed" class="summary-sig-name">setPrinterUsersAllowed</a>(<span class="summary-sig-arg">name</span>,
<span class="summary-sig-arg">allowed</span>)</span><br />
Set the list of users allowed to use a printer.</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">None</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="cups.Connection-class.html#setPrinterUsersDenied" class="summary-sig-name">setPrinterUsersDenied</a>(<span class="summary-sig-arg">name</span>,
<span class="summary-sig-arg">denied</span>)</span><br />
Set the list of users denied the use of a printer.</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
<code>__delattr__</code>,
<code>__format__</code>,
<code>__getattribute__</code>,
<code>__hash__</code>,
<code>__reduce__</code>,
<code>__reduce_ex__</code>,
<code>__setattr__</code>,
<code>__sizeof__</code>,
<code>__str__</code>,
<code>__subclasshook__</code>
</p>
</td>
</tr>
</table>
<!-- ==================== PROPERTIES ==================== -->
<a name="section-Properties"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Properties</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-Properties"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
<code>__class__</code>
</p>
</td>
</tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Method Details</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-MethodDetails"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
</table>
<a name="__init__"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">...</span>)</span>
<br /><em class="fname">(Constructor)</em>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<p>x.__init__(...) initializes x; see x.__class__.__doc__ for
signature</p>
<dl class="fields">
<dt>Overrides:
object.__init__
</dt>
</dl>
</td></tr></table>
</div>
<a name="__new__"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">__new__</span>(<span class="sig-arg">T</span>,
<span class="sig-arg">S</span>,
<span class="sig-arg">...</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<dl class="fields">
<dt>Returns: a new object with type S, a subtype of T</dt>
<dt>Overrides:
object.__new__
</dt>
</dl>
</td></tr></table>
</div>
<a name="__repr__"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">__repr__</span>(<span class="sig-arg">x</span>)</span>
<br /><em class="fname">(Representation operator)</em>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<p>repr(x)</p>
<dl class="fields">
<dt>Overrides:
object.__repr__
</dt>
</dl>
</td></tr></table>
</div>
<a name="acceptJobs"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">acceptJobs</span>(<span class="sig-arg">name</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<p>Cause printer to accept jobs.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>name</code></strong> (string) - queue name</li>
</ul></dd>
<dt>Returns: None</dt>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'><a href="cups.IPPError-class.html">IPPError</a></strong></code> - IPP problem</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="addPrinter"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">addPrinter</span>(<span class="sig-arg">name</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<p>Add or adjust a print queue. Several parameters can select which PPD
to use (filename, ppdname, and ppd) but only one may be given.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>filename</code></strong> (string) - local filename of PPD file</li>
<li><strong class="pname"><code>ppdname</code></strong> (string) - filename from <a href="cups.Connection-class.html#getPPDs"
class="link">getPPDs</a></li>
<li><strong class="pname"><code>info</code></strong> (string) - human-readable information about the printer</li>
<li><strong class="pname"><code>location</code></strong> (string) - human-readable printer location</li>
<li><strong class="pname"><code>device</code></strong> (string) - device URI string</li>
<li><strong class="pname"><code>ppd</code></strong> (<a href="cups.PPD-class.html" class="link">cups.PPD</a> instance) - PPD object</li>
</ul></dd>
<dt>Returns: None</dt>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'><a href="cups.IPPError-class.html">IPPError</a></strong></code> - IPP problem</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="addPrinterOptionDefault"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">addPrinterOptionDefault</span>(<span class="sig-arg">name</span>,
<span class="sig-arg">option</span>,
<span class="sig-arg">value</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<p>Set a network default option. Jobs submitted to the named queue will
have the job option added if it is not already present in the job. This
works with CUPS servers of at least version 1.2.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>name</code></strong> (string) - queue name</li>
<li><strong class="pname"><code>option</code></strong> (string) - option name, for example 'job-priority'</li>
<li><strong class="pname"><code>value</code></strong> (string) - option value as a string</li>
</ul></dd>
<dt>Returns: None</dt>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'><a href="cups.IPPError-class.html">IPPError</a></strong></code> - IPP problem</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="addPrinterToClass"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">addPrinterToClass</span>(<span class="sig-arg">name</span>,
<span class="sig-arg">class</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<p>Add a printer to a class. If the class does not yet exist, it is
created.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>name</code></strong> (string) - queue name</li>
<li><strong class="pname"><code>class</code></strong> (string) - class name</li>
</ul></dd>
<dt>Returns: None</dt>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'><a href="cups.IPPError-class.html">IPPError</a></strong></code> - IPP problem</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="adminGetServerSettings"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">adminGetServerSettings</span>()</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<p>Get server settings.</p>
<dl class="fields">
<dt>Returns: dict</dt>
<dd>dict representing server settings; keywords include <a
href="cups-module.html#CUPS_SERVER_DEBUG_LOGGING"
class="link">CUPS_SERVER_DEBUG_LOGGING</a>, <a
href="cups-module.html#CUPS_SERVER_REMOTE_ADMIN"
class="link">CUPS_SERVER_REMOTE_ADMIN</a>, <a
href="cups-module.html#CUPS_SERVER_REMOTE_PRINTERS"
class="link">CUPS_SERVER_REMOTE_PRINTERS</a>, <a
href="cups-module.html#CUPS_SERVER_SHARE_PRINTERS"
class="link">CUPS_SERVER_SHARE_PRINTERS</a>, <a
href="cups-module.html#CUPS_SERVER_USER_CANCEL_ANY"
class="link">CUPS_SERVER_USER_CANCEL_ANY</a></dd>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'><a href="cups.IPPError-class.html">IPPError</a></strong></code> - IPP problem</li>
</ul></dd>
</dl>
<div class="fields"> <p><strong>See Also:</strong>
<a href="cups.Connection-class.html#adminSetServerSettings"
class="link">adminSetServerSettings</a>
</p>
</div></td></tr></table>
</div>
<a name="adminSetServerSettings"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">adminSetServerSettings</span>(<span class="sig-arg">settings</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<p>Set server settings.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>settings</code></strong> (dict) - dict of server settings</li>
</ul></dd>
<dt>Returns: None</dt>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'><a href="cups.IPPError-class.html">IPPError</a></strong></code> - IPP problem</li>
</ul></dd>
</dl>
<div class="fields"> <p><strong>See Also:</strong>
<a href="cups.Connection-class.html#adminGetServerSettings"
class="link">adminGetServerSettings</a>
</p>
</div></td></tr></table>
</div>
<a name="authenticateJob"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">authenticateJob</span>(<span class="sig-arg">jobid</span>,
<span class="sig-arg">auth_info</span>=<span class="sig-default">None</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>jobid</code></strong> (integer) - job ID to authenticate</li>
<li><strong class="pname"><code>auth_info</code></strong> (optional string list) - authentication details</li>
</ul></dd>
<dt>Returns: None</dt>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'><a href="cups.IPPError-class.html">IPPError</a></strong></code> - IPP problem</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="cancelAllJobs"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">cancelAllJobs</span>(<span class="sig-arg">uri</span>,
<span class="sig-arg">my_jobs</span>=<span class="sig-default">False</span>,
<span class="sig-arg">purge_jobs</span>=<span class="sig-default">True</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>uri</code></strong> (string) - printer URI</li>
<li><strong class="pname"><code>my_jobs</code></strong> (boolean) - whether to restrict operation to jobs owned by the current CUPS
user (as set by <a href="cups-module.html#setUser"
class="link">cups.setUser</a>).</li>
<li><strong class="pname"><code>purge_jobs</code></strong> (boolean) - whether to remove data and control files</li>
</ul></dd>
<dt>Returns: None</dt>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'><a href="cups.IPPError-class.html">IPPError</a></strong></code> - IPP problem</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="cancelJob"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">cancelJob</span>(<span class="sig-arg">jobid</span>,
<span class="sig-arg">purge_job</span>=<span class="sig-default">False</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>jobid</code></strong> (integer) - job ID to cancel</li>
<li><strong class="pname"><code>purge_job</code></strong> (boolean) - whether to remove data and control files</li>
</ul></dd>
<dt>Returns: None</dt>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'><a href="cups.IPPError-class.html">IPPError</a></strong></code> - IPP problem</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="cancelSubscription"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">cancelSubscription</span>(<span class="sig-arg">id</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<p>Cancel a subscription.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>id</code></strong> (integer) - subscription ID</li>
</ul></dd>
<dt>Returns: None</dt>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'><a href="cups.IPPError-class.html">IPPError</a></strong></code> - IPP problem</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="createSubscription"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">createSubscription</span>(<span class="sig-arg">...</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<pre class="literalblock">
createSubscription(uri, events=[], job_id=-1, recipient_uri=,
lease_duration=-1, time_interval=-1,
user_data=) -> integer
Create a subscription.
@type uri: string
@param uri: URI for object
@type events: string list
@keyword events: events to receive notifications for
@type job_id: integer
@keyword job_id: job ID to receive notifications for
@type recipient_uri: string
@keyword recipient_uri: URI for notifications recipient
@type lease_duration: integer
@keyword lease_duration: lease duration in seconds
@type time_interval: integer
@keyword time_interval: time interval
@type user_data: string
@keyword user_data: user data to receieve with notifications
@return: subscription ID
@raise IPPError: IPP problem
</pre>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="deleteClass"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">deleteClass</span>(<span class="sig-arg">class</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<p>Delete a class.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>class</code></strong> (string) - class name</li>
</ul></dd>
<dt>Returns: None</dt>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'><a href="cups.IPPError-class.html">IPPError</a></strong></code> - IPP problem</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="deletePrinter"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">deletePrinter</span>(<span class="sig-arg">name</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<p>Delete a printer.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>name</code></strong> (string) - queue name</li>
</ul></dd>
<dt>Returns: None</dt>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'><a href="cups.IPPError-class.html">IPPError</a></strong></code> - IPP problem</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="deletePrinterFromClass"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">deletePrinterFromClass</span>(<span class="sig-arg">name</span>,
<span class="sig-arg">class</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<p>Remove a printer from a class. If the class would be left empty, it
is removed.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>name</code></strong> (string) - queue name</li>
<li><strong class="pname"><code>class</code></strong> (string) - class name</li>
</ul></dd>
<dt>Returns: None</dt>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'><a href="cups.IPPError-class.html">IPPError</a></strong></code> - IPP problem</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="deletePrinterOptionDefault"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">deletePrinterOptionDefault</span>(<span class="sig-arg">name</span>,
<span class="sig-arg">option</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<p>Removes a network default option. See <a
href="cups.Connection-class.html#addPrinterOptionDefault"
class="link">addPrinterOptionDefault</a>.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>name</code></strong> (string) - queue name</li>
<li><strong class="pname"><code>option</code></strong> (string) - option name, for example 'job-priority'</li>
</ul></dd>
<dt>Returns: None</dt>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'><a href="cups.IPPError-class.html">IPPError</a></strong></code> - IPP problem</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="disablePrinter"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">disablePrinter</span>(<span class="sig-arg">name</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<p>Disable printer. This prevents the printer from processing its job
queue.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>name</code></strong> (string) - queue name</li>
<li><strong class="pname"><code>reason</code></strong> (string) - optional human-readable reason for disabling the printer</li>
</ul></dd>
<dt>Returns: None</dt>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'><a href="cups.IPPError-class.html">IPPError</a></strong></code> - IPP problem</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="enablePrinter"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">enablePrinter</span>(<span class="sig-arg">name</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<p>Enable printer. This allows the printer to process its job queue.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>name</code></strong> (string) - queue name</li>
</ul></dd>
<dt>Returns: None</dt>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'><a href="cups.IPPError-class.html">IPPError</a></strong></code> - IPP problem</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="getClasses"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">getClasses</span>()</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<dl class="fields">
<dt>Returns: dict</dt>
<dd>a dict, indexed by name, of objects representing classes. Each
class object is either a string, in which case it is for the
remote class; or a list, in which case it is a list of queue
names.</dd>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'><a href="cups.IPPError-class.html">IPPError</a></strong></code> - IPP problem</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="getDefault"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">getDefault</span>()</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<p>Get the system default printer.</p>
<dl class="fields">
<dt>Returns: string or None</dt>
<dd>default printer name or None</dd>
</dl>
</td></tr></table>
</div>
<a name="getDests"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">getDests</span>()</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<dl class="fields">
<dt>Returns: dict</dt>
<dd>a dict representing available destinations. Each dictionary key
is a pair of (queue, instance) strings, and the dictionary value
is a <a href="cups.Dest-class.html" class="link">cups.Dest</a>
object. In addition to the available destinations, a special
dictionary key (None,None) is provided for looking up the default
destination; this destination will also be available under its
own key.</dd>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'><a href="cups.IPPError-class.html">IPPError</a></strong></code> - IPP problem</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="getDevices"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">getDevices</span>(<span class="sig-arg">limit</span>=<span class="sig-default">0</span>,
<span class="sig-arg">exclude_schemes</span>=<span class="sig-default">None</span>,
<span class="sig-arg">include_schemes</span>=<span class="sig-default">None</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>limit</code></strong> (integer) - maximum number of devices to return</li>
<li><strong class="pname"><code>exclude_schemes</code></strong> (string list) - URI schemes to exclude</li>
<li><strong class="pname"><code>include_schemes</code></strong> (string list) - URI schemes to include</li>
</ul></dd>
<dt>Returns: dict</dt>
<dd>a dict, indexed by device URI, of dicts representing devices,
indexed by attribute.</dd>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'><a href="cups.IPPError-class.html">IPPError</a></strong></code> - IPP problem</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="getDocument"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">getDocument</span>(<span class="sig-arg">printer_uri</span>,
<span class="sig-arg">job_id</span>,
<span class="sig-arg">document_number</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<p>Fetches the job document and stores it in a temporary file.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>printer_uri</code></strong> (string) - the printer-uri for the printer</li>
<li><strong class="pname"><code>job_id</code></strong> (integer) - the job ID</li>
<li><strong class="pname"><code>document_number</code></strong> (integer) - the document number to retrieve</li>
</ul></dd>
<dt>Returns: dict</dt>
<dd>a dict with the following keys: 'file' (string), temporary
filename holding the job document; 'document-format' (string),
its MIME type. There may also be a 'document-name' key, in
which case this is for the document name.</dd>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'>RuntimeError</strong></code> - Not supported in libcups until 1.4</li>
<li><code><strong class='fraise'><a href="cups.IPPError-class.html">IPPError</a></strong></code> - IPP problem</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="getFile"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">getFile</span>(<span class="sig-arg">resource</span>,
<span class="sig-arg">filename</span>=<span class="sig-default">None</span>,
<span class="sig-arg">fd</span>=<span class="sig-default">-1</span>,
<span class="sig-arg">file</span>=<span class="sig-default">None</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<p>Fetch a CUPS server resource to a local file.</p>
<p>This is for obtaining CUPS server configuration files and log
files.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>resource</code></strong> (string) - resource name</li>
<li><strong class="pname"><code>filename</code></strong> (string) - name of local file for storage</li>
<li><strong class="pname"><code>fd</code></strong> (int) - file descriptor of local file</li>
<li><strong class="pname"><code>file</code></strong> (file) - Python file object for local file</li>
</ul></dd>
<dt>Returns: None</dt>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'><a href="cups.HTTPError-class.html">HTTPError</a></strong></code> - HTTP problem</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="getJobAttributes"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">getJobAttributes</span>(<span class="sig-arg">jobid</span>,
<span class="sig-arg">requested_attributes</span>=<span class="sig-default">None</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<p>Fetch job attributes.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>jobid</code></strong> (integer) - job ID</li>
<li><strong class="pname"><code>requested_attributes</code></strong> (string list) - list of requested attribute names</li>
</ul></dd>
<dt>Returns: dict</dt>
<dd>a dict representing job attributes.</dd>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'><a href="cups.IPPError-class.html">IPPError</a></strong></code> - IPP problem</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="getJobs"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">getJobs</span>(<span class="sig-arg">which_jobs</span>=<span class="sig-default">'not-completed'</span>,
<span class="sig-arg">my_jobs</span>=<span class="sig-default">False</span>,
<span class="sig-arg">limit</span>=<span class="sig-default">-1</span>,
<span class="sig-arg">first_job_id</span>=<span class="sig-default">-1</span>,
<span class="sig-arg">requested_attributes</span>=<span class="sig-default">None</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<p>Fetch a list of jobs.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>which_jobs</code></strong> (string) - which jobs to fetch; possible values: 'completed',
'not-completed', 'all'</li>
<li><strong class="pname"><code>my_jobs</code></strong> (boolean) - whether to restrict the returned jobs to those owned by the
current CUPS user (as set by <a href="cups-module.html#setUser"
class="link">cups.setUser</a>).</li>
<li><strong class="pname"><code>limit</code></strong> (integer) - maximum number of jobs to return</li>
<li><strong class="pname"><code>first_job_id</code></strong> (integer) - lowest job ID to return</li>
<li><strong class="pname"><code>requested_attributes</code></strong> (string list) - list of requested attribute names</li>
</ul></dd>
<dt>Returns: dict</dt>
<dd>a dict, indexed by job ID, of dicts representing job attributes.</dd>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'><a href="cups.IPPError-class.html">IPPError</a></strong></code> - IPP problem</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="getNotifications"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">getNotifications</span>(<span class="sig-arg">subscription_ids</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<p>Get notifications for subscribed events.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>subscription_ids</code></strong> (integer list) - list of subscription IDs to receive notifications for</li>
</ul></dd>
<dt>Returns: list</dt>
<dd>list of dicts, each representing an event</dd>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'><a href="cups.IPPError-class.html">IPPError</a></strong></code> - IPP problem</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="getPPD"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">getPPD</span>(<span class="sig-arg">name</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<p>Fetch a printer's PPD.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>name</code></strong> (string) - queue name</li>
</ul></dd>
<dt>Returns: string</dt>
<dd>temporary PPD file name</dd>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'><a href="cups.IPPError-class.html">IPPError</a></strong></code> - IPP problem</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="getPPD3"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">getPPD3</span>(<span class="sig-arg">name</span>,
<span class="sig-arg">modtime</span>=<span class="sig-default">...</span>,
<span class="sig-arg">filename</span>=<span class="sig-default">...</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<p>Fetch a printer's PPD if it is newer.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>name</code></strong> (string) - queue name</li>
<li><strong class="pname"><code>modtime</code></strong> (float) - modification time of existing file</li>
<li><strong class="pname"><code>filename</code></strong> (string) - filename of existing file</li>
</ul></dd>
<dt>Returns: (status,modtime,filename)</dt>
<dd>tuple of HTTP status, modification time, and filename</dd>
</dl>
</td></tr></table>
</div>
<a name="getPPDs"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">getPPDs</span>(<span class="sig-arg">limit</span>=<span class="sig-default">0</span>,
<span class="sig-arg">exclude_schemes</span>=<span class="sig-default">None</span>,
<span class="sig-arg">include_schemes</span>=<span class="sig-default">None</span>,
<span class="sig-arg">ppd_natural_language</span>=<span class="sig-default">None</span>,
<span class="sig-arg">ppd_device_id</span>=<span class="sig-default">None</span>,
<span class="sig-arg">ppd_make</span>=<span class="sig-default">None</span>,
<span class="sig-arg">ppd_make_and_model</span>=<span class="sig-default">None</span>,
<span class="sig-arg">ppd_model_number</span>=<span class="sig-default">-1</span>,
<span class="sig-arg">ppd_product</span>=<span class="sig-default">None</span>,
<span class="sig-arg">ppd_psversion</span>=<span class="sig-default">None</span>,
<span class="sig-arg">ppd_type</span>=<span class="sig-default">None</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>limit</code></strong> (integer) - maximum number of PPDs to return</li>
<li><strong class="pname"><code>exclude_schemes</code></strong> (string list) - list of PPD schemes to exclude</li>
<li><strong class="pname"><code>include_schemes</code></strong> (string list) - list of PPD schemes to include</li>
<li><strong class="pname"><code>ppd_natural_language</code></strong> (string) - required language</li>
<li><strong class="pname"><code>ppd_device_id</code></strong> (string) - IEEE 1284 Device ID to match against</li>
<li><strong class="pname"><code>ppd_make</code></strong> (string) - required printer manufacturer</li>
<li><strong class="pname"><code>ppd_make_and_model</code></strong> (string) - required make and model</li>
<li><strong class="pname"><code>ppd_model_number</code></strong> (integer) - model number required (from cupsModelNumber in PPD file)</li>
<li><strong class="pname"><code>ppd_product</code></strong> (string) - required PostScript product string (Product)</li>
<li><strong class="pname"><code>ppd_psversion</code></strong> (string) - required PostScript version (PSVersion)</li>
<li><strong class="pname"><code>ppd_type</code></strong> (string) - required type of PPD. Valid values are fax; pdf; postscript;
raster; unknown.</li>
</ul></dd>
<dt>Returns: dict</dt>
<dd>a dict, indexed by PPD name, of dicts representing PPDs, indexed
by attribute.</dd>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'><a href="cups.IPPError-class.html">IPPError</a></strong></code> - IPP problem</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="getPPDs2"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">getPPDs2</span>(<span class="sig-arg">limit</span>=<span class="sig-default">0</span>,
<span class="sig-arg">exclude_schemes</span>=<span class="sig-default">None</span>,
<span class="sig-arg">include_schemes</span>=<span class="sig-default">None</span>,
<span class="sig-arg">ppd_natural_language</span>=<span class="sig-default">None</span>,
<span class="sig-arg">ppd_device_id</span>=<span class="sig-default">None</span>,
<span class="sig-arg">ppd_make</span>=<span class="sig-default">None</span>,
<span class="sig-arg">ppd_make_and_model</span>=<span class="sig-default">None</span>,
<span class="sig-arg">ppd_model_number</span>=<span class="sig-default">-1</span>,
<span class="sig-arg">ppd_product</span>=<span class="sig-default">None</span>,
<span class="sig-arg">ppd_psversion</span>=<span class="sig-default">None</span>,
<span class="sig-arg">ppd_type</span>=<span class="sig-default">None</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>limit</code></strong> (integer) - maximum number of PPDs to return</li>
<li><strong class="pname"><code>exclude_schemes</code></strong> (string list) - list of PPD schemes to exclude</li>
<li><strong class="pname"><code>include_schemes</code></strong> (string list) - list of PPD schemes to include</li>
<li><strong class="pname"><code>ppd_natural_language</code></strong> (string) - required language</li>
<li><strong class="pname"><code>ppd_device_id</code></strong> (string) - IEEE 1284 Device ID to match against</li>
<li><strong class="pname"><code>ppd_make</code></strong> (string) - required printer manufacturer</li>
<li><strong class="pname"><code>ppd_make_and_model</code></strong> (string) - required make and model</li>
<li><strong class="pname"><code>ppd_model_number</code></strong> (integer) - model number required (from cupsModelNumber in PPD file)</li>
<li><strong class="pname"><code>ppd_product</code></strong> (string) - required PostScript product string (Product)</li>
<li><strong class="pname"><code>ppd_psversion</code></strong> (string) - required PostScript version (PSVersion)</li>
<li><strong class="pname"><code>ppd_type</code></strong> (string) - required type of PPD. Valid values are fax; pdf; postscript;
raster; unknown.</li>
</ul></dd>
<dt>Returns: dict</dt>
<dd>a dict, indexed by PPD name, of dicts representing PPDs, indexed
by attribute. All attribute values are lists.</dd>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'><a href="cups.IPPError-class.html">IPPError</a></strong></code> - IPP problem</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="getPrinterAttributes"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">getPrinterAttributes</span>(<span class="sig-arg">name</span>=<span class="sig-default">None</span>,
<span class="sig-arg">uri</span>=<span class="sig-default">None</span>,
<span class="sig-arg">requested_attributes</span>=<span class="sig-default">None</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<p>Fetch the attributes for a printer, specified either by name or by uri
but not both.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>name</code></strong> (string) - queue name</li>
<li><strong class="pname"><code>uri</code></strong> (string) - queue URI</li>
<li><strong class="pname"><code>requested_attributes</code></strong> (string list) - list of requested attribute names</li>
</ul></dd>
<dt>Returns: dict</dt>
<dd>a dict, indexed by attribute, of printer attributes for the
specified printer.
<p>Attributes:</p>
<ul>
<li>
'job-sheets-supported': list of strings
</li>
<li>
'job-sheets-default': tuple of strings (start, end)
</li>
<li>
'printer-error-policy-supported': if present, list of strings
</li>
<li>
'printer-error-policy': if present, string
</li>
<li>
'printer-op-policy-supported': if present, list of strings
</li>
<li>
'printer-op-policy': if present, string
</li>
</ul>
<p>There are other attributes; the exact list of attributes
returned will depend on the IPP server.</p></dd>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'><a href="cups.IPPError-class.html">IPPError</a></strong></code> - IPP problem</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="getPrinters"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">getPrinters</span>()</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<dl class="fields">
<dt>Returns: dict</dt>
<dd>a dict, indexed by name, of dicts representing queues, indexed by
attribute.</dd>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'><a href="cups.IPPError-class.html">IPPError</a></strong></code> - IPP problem</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="getServerPPD"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">getServerPPD</span>(<span class="sig-arg">ppd_name</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<p>Fetches the named PPD and stores it in a temporary file.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>ppd_name</code></strong> (string) - the ppd-name of a PPD</li>
</ul></dd>
<dt>Returns: string</dt>
<dd>temporary filename holding the PPD</dd>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'>RuntimeError</strong></code> - Not supported in libcups until 1.3</li>
<li><code><strong class='fraise'><a href="cups.IPPError-class.html">IPPError</a></strong></code> - IPP problem</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="getSubscriptions"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">getSubscriptions</span>(<span class="sig-arg">uri</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<p>Get subscriptions.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>uri</code></strong> (string) - URI for object</li>
<li><strong class="pname"><code>my_subscriptions</code></strong> (boolean) - only return subscriptions belonging to the current user (default
False)</li>
<li><strong class="pname"><code>job_id</code></strong> (integer) - only return subscriptions relating to this job</li>
</ul></dd>
<dt>Returns: integer list</dt>
<dd>list of subscriptions</dd>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'><a href="cups.IPPError-class.html">IPPError</a></strong></code> - IPP problem</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="moveJob"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">moveJob</span>(<span class="sig-arg">printer_uri</span>=<span class="sig-default">None</span>,
<span class="sig-arg">job_id</span>=<span class="sig-default">-1</span>,
<span class="sig-arg">job_printer_uri</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<p>Move a job specified by printer_uri and jobid (only one need be given)
to the printer specified by job_printer_uri.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>job_id</code></strong> (integer) - job ID to move</li>
<li><strong class="pname"><code>printer_uri</code></strong> (string) - printer to move job(s) from</li>
<li><strong class="pname"><code>job_printer_uri</code></strong> (string) - printer to move job(s) to</li>
</ul></dd>
<dt>Returns: None</dt>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'><a href="cups.IPPError-class.html">IPPError</a></strong></code> - IPP problem</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="printFile"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">printFile</span>(<span class="sig-arg">printer</span>,
<span class="sig-arg">filename</span>,
<span class="sig-arg">title</span>,
<span class="sig-arg">options</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<p>Print a file.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>printer</code></strong> (string) - queue name</li>
<li><strong class="pname"><code>filename</code></strong> (string) - local file path to the document</li>
<li><strong class="pname"><code>title</code></strong> (string) - title of the print job</li>
<li><strong class="pname"><code>options</code></strong> (dict) - dict of options</li>
</ul></dd>
<dt>Returns: integer</dt>
<dd>job ID</dd>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'><a href="cups.IPPError-class.html">IPPError</a></strong></code> - IPP problem</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="printFiles"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">printFiles</span>(<span class="sig-arg">printer</span>,
<span class="sig-arg">filenames</span>,
<span class="sig-arg">title</span>,
<span class="sig-arg">options</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<p>Print a list of files.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>printer</code></strong> (string) - queue name</li>
<li><strong class="pname"><code>filenames</code></strong> (list) - list of local file paths to the documents</li>
<li><strong class="pname"><code>title</code></strong> (string) - title of the print job</li>
<li><strong class="pname"><code>options</code></strong> (dict) - dict of options</li>
</ul></dd>
<dt>Returns: integer</dt>
<dd>job ID</dd>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'><a href="cups.IPPError-class.html">IPPError</a></strong></code> - IPP problem</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="printTestPage"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">printTestPage</span>(<span class="sig-arg">name</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<p>Print a test page.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>name</code></strong> (string) - queue name</li>
<li><strong class="pname"><code>file</code></strong> (string) - input file (default is CUPS test page)</li>
<li><strong class="pname"><code>title</code></strong> (string) - job title (default 'Test Page')</li>
<li><strong class="pname"><code>format</code></strong> (string) - document format (default 'application/postscript')</li>
<li><strong class="pname"><code>user</code></strong> (string) - user to submit the job as</li>
</ul></dd>
<dt>Returns: job ID</dt>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'><a href="cups.IPPError-class.html">IPPError</a></strong></code> - IPP problem</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="putFile"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">putFile</span>(<span class="sig-arg">resource</span>,
<span class="sig-arg">filename</span>=<span class="sig-default">None</span>,
<span class="sig-arg">fd</span>=<span class="sig-default">-1</span>,
<span class="sig-arg">file</span>=<span class="sig-default">None</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<p>This is for uploading new configuration files for the CUPS server.
Note: <a href="cups.Connection-class.html#adminSetServerSettings"
class="link">adminSetServerSettings</a> is a way of adjusting server
settings without needing to parse the configuration file.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>resource</code></strong> (string) - resource name</li>
<li><strong class="pname"><code>filename</code></strong> (string) - name of local file to upload</li>
<li><strong class="pname"><code>fd</code></strong> (int) - file descriptor of local file</li>
<li><strong class="pname"><code>file</code></strong> (file) - Python file object for local file</li>
</ul></dd>
<dt>Returns: None</dt>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'><a href="cups.HTTPError-class.html">HTTPError</a></strong></code> - HTTP problem</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="rejectJobs"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">rejectJobs</span>(<span class="sig-arg">name</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<p>Cause printer to reject jobs.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>name</code></strong> (string) - queue name</li>
<li><strong class="pname"><code>reason</code></strong> (string) - optional human-readable reason for rejecting jobs</li>
</ul></dd>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'><a href="cups.IPPError-class.html">IPPError</a></strong></code> - IPP problem</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="renewSubscription"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">renewSubscription</span>(<span class="sig-arg">id</span>,
<span class="sig-arg">lease_duration</span>=<span class="sig-default">-1</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<p>Renew a subscription.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>id</code></strong> (integer) - subscription ID</li>
<li><strong class="pname"><code>lease_duration</code></strong> (integer) - lease duration in seconds</li>
</ul></dd>
<dt>Returns: None</dt>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'><a href="cups.IPPError-class.html">IPPError</a></strong></code> - IPP problem</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="restartJob"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">restartJob</span>(<span class="sig-arg">job_id</span>,
<span class="sig-arg">job_hold_until</span>=<span class="sig-default">None</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<p>Restart a job.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>job_id</code></strong> (integer) - job ID to restart</li>
<li><strong class="pname"><code>job_hold_until</code></strong> (string) - new job-hold-until value for job</li>
</ul></dd>
<dt>Returns: None</dt>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'><a href="cups.IPPError-class.html">IPPError</a></strong></code> - IPP problem</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="setDefault"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">setDefault</span>(<span class="sig-arg">name</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<p>Set the system default printer. Note that this can be over-ridden on
a per-user basis using the lpoptions command.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>name</code></strong> (string) - queue name</li>
</ul></dd>
<dt>Returns: None</dt>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'><a href="cups.IPPError-class.html">IPPError</a></strong></code> - IPP problem</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="setJobHoldUntil"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">setJobHoldUntil</span>(<span class="sig-arg">jobid</span>,
<span class="sig-arg">job_hold_until</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<p>Specifies when a job should be printed.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>jobid</code></strong> (integer) - job ID to adjust</li>
<li><strong class="pname"><code>job_hold_until</code></strong> (string) - when to print the job; examples: 'hold', 'immediate', 'restart',
resume'</li>
</ul></dd>
<dt>Returns: None</dt>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'><a href="cups.IPPError-class.html">IPPError</a></strong></code> - IPP problem</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="setPrinterDevice"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">setPrinterDevice</span>(<span class="sig-arg">name</span>,
<span class="sig-arg">device_uri</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<p>Set the device URI for a printer.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>name</code></strong> (string) - queue name</li>
<li><strong class="pname"><code>device_uri</code></strong> (string) - device URI</li>
</ul></dd>
<dt>Returns: None</dt>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'><a href="cups.IPPError-class.html">IPPError</a></strong></code> - IPP problem</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="setPrinterErrorPolicy"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">setPrinterErrorPolicy</span>(<span class="sig-arg">name</span>,
<span class="sig-arg">policy</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<p>Set the printer's error policy.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>name</code></strong> (string) - queue name</li>
<li><strong class="pname"><code>policy</code></strong> (string) - policy name; supported policy names can be found by using the <a
href="cups.Connection-class.html#getPrinterAttributes"
class="link">getPrinterAttributes</a> function and looking for
the 'printer-error-policy-supported' attribute</li>
</ul></dd>
<dt>Returns: None</dt>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'><a href="cups.IPPError-class.html">IPPError</a></strong></code> - IPP problem</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="setPrinterInfo"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">setPrinterInfo</span>(<span class="sig-arg">name</span>,
<span class="sig-arg">info</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<p>Set the human-readable information about a printer.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>name</code></strong> (string) - queue name</li>
<li><strong class="pname"><code>info</code></strong> (string) - human-readable information about the printer</li>
</ul></dd>
<dt>Returns: None</dt>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'><a href="cups.IPPError-class.html">IPPError</a></strong></code> - IPP problem</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="setPrinterJobSheets"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">setPrinterJobSheets</span>(<span class="sig-arg">name</span>,
<span class="sig-arg">start</span>,
<span class="sig-arg">end</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<p>Specifies job sheets for a printer.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>name</code></strong> (string) - queue name</li>
<li><strong class="pname"><code>start</code></strong> (string) - name of a sheet to print before each job</li>
<li><strong class="pname"><code>end</code></strong> (string) - name of a sheet to print after each job</li>
</ul></dd>
<dt>Returns: None</dt>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'><a href="cups.IPPError-class.html">IPPError</a></strong></code> - IPP problem</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="setPrinterLocation"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">setPrinterLocation</span>(<span class="sig-arg">name</span>,
<span class="sig-arg">location</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<p>Set the human-readable printer location</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>name</code></strong> (string) - queue name</li>
<li><strong class="pname"><code>location</code></strong> (string) - human-readable printer location</li>
</ul></dd>
<dt>Returns: None</dt>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'><a href="cups.IPPError-class.html">IPPError</a></strong></code> - IPP problem</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="setPrinterOpPolicy"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">setPrinterOpPolicy</span>(<span class="sig-arg">name</span>,
<span class="sig-arg">policy</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<p>Set the printer's operation policy.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>name</code></strong> (string) - queue name</li>
<li><strong class="pname"><code>policy</code></strong> (string) - policy name; supported policy names can be found by using the <a
href="cups.Connection-class.html#getPrinterAttributes"
class="link">getPrinterAttributes</a> function and looking for
the 'printer-op-policy-supported' attribute</li>
</ul></dd>
<dt>Returns: None</dt>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'><a href="cups.IPPError-class.html">IPPError</a></strong></code> - IPP problem</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="setPrinterShared"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">setPrinterShared</span>(<span class="sig-arg">name</span>,
<span class="sig-arg">shared</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<p>Set whether a printer is shared with other people. This works with
CUPS servers of at least version 1.2, by setting the printer-is-shared
printer attribute.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>name</code></strong> (string) - queue name</li>
<li><strong class="pname"><code>shared</code></strong> (boolean) - whether printer should be shared</li>
</ul></dd>
<dt>Returns: None</dt>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'><a href="cups.IPPError-class.html">IPPError</a></strong></code> - IPP problem</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="setPrinterUsersAllowed"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">setPrinterUsersAllowed</span>(<span class="sig-arg">name</span>,
<span class="sig-arg">allowed</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<p>Set the list of users allowed to use a printer. This works with CUPS
server of at least version 1.2, by setting the
requesting-user-name-allowed printer attribute.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>name</code></strong> (string) - queue name</li>
<li><strong class="pname"><code>allowed</code></strong> (string list) - list of allowed users; ['all'] means there will be no user-name
restriction.</li>
</ul></dd>
<dt>Returns: None</dt>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'><a href="cups.IPPError-class.html">IPPError</a></strong></code> - IPP problem</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="setPrinterUsersDenied"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">setPrinterUsersDenied</span>(<span class="sig-arg">name</span>,
<span class="sig-arg">denied</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<p>Set the list of users denied the use of a printer. This works with
CUPS servers of at least version 1.2, by setting the
requesting-user-name-denied printer attribute.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>name</code></strong> (string) - queue name</li>
<li><strong class="pname"><code>denied</code></strong> (string list) - list of denied users; ['none'] means there will be no user-name
restriction.</li>
</ul></dd>
<dt>Returns: None</dt>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'><a href="cups.IPPError-class.html">IPPError</a></strong></code> - IPP problem</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th> <a
href="cups-module.html">Home</a> </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<th class="navbar" width="100%"></th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
Generated by Epydoc 3.0.1 on Tue Oct 25 14:13:39 2011
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
>http://epydoc.sourceforge.net</a>
</td>
</tr>
</table>
<script type="text/javascript">
<!--
// Private objects are initially displayed (because if
// javascript is turned off then we want them to be
// visible); but by default, we want to hide them. So hide
// them unless we have a cookie that says to show them.
checkCookie();
// -->
</script>
</body>
</html>
distrib
>
Fedora
>
14
>
x86_64
>
media
>
updates
>
by-pkgid
>
8f80db0cfd7be337c42fad862662e466
>
files
>
40
