3 <!-- SECTION: Programming -->
5 <title>Administration APIs
</title>
6 <meta name=
"keywords" content=
"Programming">
7 <meta http-equiv=
"Content-Type" content=
"text/html;charset=utf-8">
8 <meta name=
"creator" content=
"Mini-XML v2.11">
9 <meta name=
"author" content=
"Unknown">
10 <meta name=
"copyright" content=
"Unknown">
11 <meta name=
"version" content=
"0.0">
12 <style type=
"text/css"><!--
14 font-family: lucida grande, geneva, helvetica, arial, sans-serif;
17 H1, H2, H3, H4, H5, H6, P, TD, TH {
18 font-family: lucida grande, geneva, helvetica, arial, sans-serif;
22 font-family: monaco, courier, monospace;
27 font-family: monaco, courier, monospace;
31 border-left: solid 2px #777;
40 PRE.command, PRE.example {
67 PRE.command EM, PRE.example EM {
68 font-family: lucida grande, geneva, helvetica, arial, sans-serif;
72 font-family: monaco, courier, monospace;
88 -moz-border-radius: 10px;
93 text-decoration: none;
96 A:link:hover, A:visited:hover, A:active {
97 text-decoration: underline;
104 TR.data, TD.data, TR.data TD {
107 border-bottom: solid 1pt #999999;
111 border-bottom: solid 1pt #999999;
118 border: solid thin #999999;
119 border-collapse: collapse;
135 border: solid thin #cccccc;
142 border-bottom: solid thin #999999;
151 caption-side: bottom;
175 border: thin solid black;
183 H2 SPAN.info, H3 SPAN.info, H4 SPAN.info {
192 border-bottom: solid 2pt #000000;
195 DIV.indent, TABLE.indent {
203 border-collapse: collapse;
206 TABLE.indent TD, TABLE.indent TH {
211 border-collapse: collapse;
219 border-bottom: solid thin #cccccc;
224 vertical-align: bottom;
233 border-bottom: solid thin #eeeeee;
238 TABLE.list TR:nth-child(even) {
242 TABLE.list TR:nth-child(odd) {
261 font-family: monaco, courier, monospace;
265 border: solid thin #999999;
266 border-collapse: collapse;
271 DIV.summary TABLE TD, DIV.summary TABLE TH {
272 border: solid thin #999999;
278 DIV.summary TABLE THEAD TH {
282 /* API documentation styles... */
294 margin-bottom: 0.5em;
299 margin-bottom: 0.5em;
304 margin-bottom: 0.5em;
309 border: solid thin black;
318 div.contents ul.contents {
322 border-bottom: solid 2px gray;
332 border-bottom: solid 2px gray;
335 border-bottom: solid 2px gray;
347 border-bottom: solid 2px gray;
350 border-bottom: solid 2px gray;
353 border-bottom: solid 2px gray;
357 h1, h2, h3, h4, h5, h6 {
358 page-break-inside: avoid;
361 border: solid thin gray;
362 box-shadow: 3px 3px 5px rgba(0,0,0,0.5);
364 page-break-inside: avoid;
366 p code, li code, p.code, pre, ul.code li {
367 background: rgba(127,127,127,0.1);
368 border: thin dotted gray;
369 font-family: monospace;
372 -webkit-hyphens: manual;
373 page-break-inside: avoid;
375 p.code, pre, ul.code li {
382 text-decoration: none;
386 border: solid thin black;
393 h3 span.info, h4 span.info {
394 border-top-left-radius: 10px;
395 border-top-right-radius: 10px;
399 ul.code, ul.contents, ul.subcontents {
400 list-style-type: none;
410 ul.contents li ul.code, ul.contents li ul.subcontents {
414 border-collapse: collapse;
417 table.list tr:nth-child(even) {
418 background: rgba(127,127,127,0.1);]n}
420 border-right: 2px solid gray;
421 font-family: monospace;
422 padding: 5px 10px 5px 2px;
427 padding: 5px 2px 5px 10px;
434 border-bottom: solid 2px black;
437 border-bottom: solid 2px black;
443 Administrative API header for CUPS.
445 Copyright © 2016 by Apple Inc.
447 Licensed under Apache License v2.0. See the file "LICENSE" for more
451 <h1 class='title'
>Administrative APIs
</h1>
453 <div class='summary'
><table summary='General Information'
>
457 <th>cups/adminutil.h
</th>
467 <td>Programming:
<a href='api-overview.html' target='_top'
>Introduction to CUPS Programming
</a><br>
468 Programming:
<a href='api-cups.html' target='_top'
>CUPS API
</a><br>
469 Programming:
<a href='api-httpipp.html' target='_top'
>HTTP and IPP APIs
</a></td>
473 <div class=
"contents">
474 <h2 class=
"title">Contents
</h2>
475 <ul class=
"contents">
476 <li><a href=
"#OVERVIEW">Overview
</a><ul class=
"subcontents">
477 <li><a href=
"#SETTINGS">Scheduler Settings
</a></li>
478 <li><a href=
"#DEVICES">Devices
</a></li>
480 <li><a href=
"#FUNCTIONS">Functions
</a><ul class=
"subcontents">
481 <li><a href=
"#cupsAdminCreateWindowsPPD">cupsAdminCreateWindowsPPD
</a></li>
482 <li><a href=
"#cupsAdminExportSamba">cupsAdminExportSamba
</a></li>
483 <li><a href=
"#cupsAdminGetServerSettings">cupsAdminGetServerSettings
</a></li>
484 <li><a href=
"#cupsAdminSetServerSettings">cupsAdminSetServerSettings
</a></li>
485 <li><a href=
"#cupsGetDevices">cupsGetDevices
</a></li>
487 <li><a href=
"#TYPES">Data Types
</a><ul class=
"subcontents">
488 <li><a href=
"#cups_device_cb_t">cups_device_cb_t
</a></li>
494 Administrative API documentation for CUPS.
496 Copyright © 2016 by Apple Inc.
498 Licensed under Apache License v2.0. See the file "LICENSE" for more
502 <h2 class=
"title"><a name=
"OVERVIEW">Overview
</a></h2>
504 <p>The administrative APIs provide convenience functions to perform certain administrative functions with the CUPS scheduler.
</p>
506 <blockquote><b>Note:
<b>
507 <p>Administrative functions normally require administrative privileges to execute and must not be used in ordinary user applications!
</p>
510 <h3><a name=
"SETTINGS">Scheduler Settings
</a></h3>
512 <p>The
<a href=
"#cupsAdminGetServerSettings"><code>cupsAdminGetServerSettings
</code></a> and
<a href=
"#cupsAdminSetServerSettings"><code>cupsAdminSetServerSettings
</code></a> functions allow you to get and set simple directives and their values, respectively, in the
<var>cupsd.conf
</var> file for the CUPS scheduler. Settings are stored in CUPS option arrays which provide a simple list of string name/value pairs. While any simple
<var>cupsd.conf
</var> directive name can be specified, the following convenience names are also defined to control common complex directives:
</p>
515 <li><code>CUPS_SERVER_DEBUG_LOGGING
</code></li>: For
<code>cupsAdminGetServerSettings
</code>, a value of
"1" means that the
<code>LogLevel
</code> directive is set to
<code>debug
</code> or
<code>debug2
</code> while a value of
"0" means it is set to any other value. For
<code>cupsAdminSetServerSettings
</code> a value of
"1" sets the
<code>LogLeveL
</code> to
<code>debug
</code> while a value of
"0" sets it to
<code>warn
</code>.
</li>
516 <li><code>CUPS_SERVER_REMOTE_ADMIN
</code></li>: A value of
"1" specifies that administrative requests are accepted from remote addresses while
"0" specifies that requests are only accepted from local addresses (loopback interface and domain sockets).
</li>
517 <li><code>CUPS_SERVER_REMOTE_ANY
</code></li>: A value of
"1" specifies that requests are accepts from any address while
"0" specifies that requests are only accepted from the local subnet (when sharing is enabled) or local addresses (loopback interface and domain sockets).
</li>
518 <li><code>CUPS_SERVER_SHARE_PRINTERS
</code></li>: A value of
"1" specifies that printer sharing is enabled for selected printers and remote requests are accepted while a value of
"0" specifies that printer sharing is disables and remote requests are not accepted.
</li>
519 <li><code>CUPS_SERVER_USER_CANCEL_ANY
</code></li>: A value of
"1" specifies that the default security policy allows any user to cancel any print job, regardless of the owner. A value of
"0" specifies that only administrative users can cancel other user's jobs.
</li>
522 <blockquote><b>Note:
</b>
523 <p>Changing settings will restart the CUPS scheduler.
</p>
524 <p>When printer sharing or the web interface are enabled, the scheduler's launch-on-demand functionality is effectively disabled. This can affect power usage, system performance, and the security profile of a system.
</p>
527 <p>The recommended way to make changes to the
<var>cupsd.conf
</var> is to first call
<a href=
"#cupsAdminGetServerSettings"><code>cupsAdminGetServerSettings
</code></a>, make any changes to the returned option array, and then call
<a href=
"#cupsAdminSetServerSettings"><code>cupsAdminSetServerSettings
</code></a> to save those settings. For example, to enable the web interface:
</p>
529 <pre class=
"example">
530 #include
<cups/cups.h
>
531 #include
<cups/adminutil.h
>
534 enable_web_interface(void)
536 int num_settings =
0; /* Number of settings */
537 cups_option_t *settings = NULL; /* Settings */
540 if (!
<a href=
"#cupsAdminGetServerSettings">cupsAdminGetServerSettings
</a>(CUPS_HTTP_DEFAULT,
&num_settings,
&settings))
542 fprintf(stderr,
"ERROR: Unable to get server settings: %s\n", cupsLastErrorString());
546 num_settings =
<a href=
"api-cups.html#cupsAddOption">cupsAddOption
</a>(
"WebInterface",
"Yes", num_settings,
&settings);
548 if (!
<a href=
"#cupsAdminSetServerSettings">cupsAdminSetServerSettings
</a>(CUPS_HTTP_DEFAULT, num_settings, settings))
550 fprintf(stderr,
"ERROR: Unable to set server settings: %s\n", cupsLastErrorString());
553 <a href=
"api-cups.html#cupsFreeOptions">cupsFreeOptions
</a>(num_settings, settings);
557 <h3><a name=
"DEVICES">Devices
</a></h3>
559 <p>Printers can be discovered through the CUPS scheduler using the
<a href=
"#cupsGetDevices"><code>cupsGetDevices
</code></a> API. Typically this API is used to locate printers to add the the system. Each device that is found will cause a supplied callback function to be executed. For example, to list the available printer devices that can be found within
30 seconds:
</p>
561 <pre class=
"example">
562 #include
<cups/cups.h
>
563 #include
<cups/adminutil.h
>
568 const char *device_class, /* I - Class */
569 const char *device_id, /* I -
1284 device ID */
570 const char *device_info, /* I - Description */
571 const char *device_make_and_model, /* I - Make and model */
572 const char *device_uri, /* I - Device URI */
573 const char *device_location, /* I - Location */
574 void *user_data) /* I - User data */
583 <a href=
"#cupsGetDevices">cupsGetDevices
</a>(CUPS_HTTP_DEFAULT,
30, NULL, NULL, get_devices_cb, NULL);
586 <h2 class=
"title"><a id=
"FUNCTIONS">Functions
</a></h2>
587 <h3 class=
"function"><span class=
"info"> DEPRECATED
 </span><a id=
"cupsAdminCreateWindowsPPD">cupsAdminCreateWindowsPPD
</a></h3>
588 <p class=
"description">Create the Windows PPD file for a printer.
</p>
590 char *cupsAdminCreateWindowsPPD(http_t *http, const char *dest, char *buffer, int bufsize);
</p>
591 <h4 class=
"parameters">Parameters
</h4>
592 <table class=
"list"><tbody>
594 <td class=
"description">Connection to server or
<code>CUPS_HTTP_DEFAULT
</code></td></tr>
596 <td class=
"description">Printer or class
</td></tr>
598 <td class=
"description">Filename buffer
</td></tr>
600 <td class=
"description">Size of filename buffer
</td></tr>
602 <h4 class=
"returnvalue">Return Value
</h4>
603 <p class=
"description">PPD file or NULL
</p>
604 <h3 class=
"function"><span class=
"info"> DEPRECATED
 </span><a id=
"cupsAdminExportSamba">cupsAdminExportSamba
</a></h3>
605 <p class=
"description">Export a printer to Samba.
</p>
607 int cupsAdminExportSamba(const char *dest, const char *ppd, const char *samba_server, const char *samba_user, const char *samba_password, FILE *logfile);
</p>
608 <h4 class=
"parameters">Parameters
</h4>
609 <table class=
"list"><tbody>
611 <td class=
"description">Destination to export
</td></tr>
613 <td class=
"description">PPD file
</td></tr>
614 <tr><th>samba_server
</th>
615 <td class=
"description">Samba server
</td></tr>
616 <tr><th>samba_user
</th>
617 <td class=
"description">Samba username
</td></tr>
618 <tr><th>samba_password
</th>
619 <td class=
"description">Samba password
</td></tr>
621 <td class=
"description">Log file, if any
</td></tr>
623 <h4 class=
"returnvalue">Return Value
</h4>
624 <p class=
"description">1 on success,
0 on failure
</p>
625 <h3 class=
"function"><span class=
"info"> CUPS
1.3/macOS
10.5 </span><a id=
"cupsAdminGetServerSettings">cupsAdminGetServerSettings
</a></h3>
626 <p class=
"description">Get settings from the server.
</p>
628 int cupsAdminGetServerSettings(http_t *http, int *num_settings, cups_option_t **settings);
</p>
629 <h4 class=
"parameters">Parameters
</h4>
630 <table class=
"list"><tbody>
632 <td class=
"description">Connection to server or
<code>CUPS_HTTP_DEFAULT
</code></td></tr>
633 <tr><th>num_settings
</th>
634 <td class=
"description">Number of settings
</td></tr>
635 <tr><th>settings
</th>
636 <td class=
"description">Settings
</td></tr>
638 <h4 class=
"returnvalue">Return Value
</h4>
639 <p class=
"description">1 on success,
0 on failure
</p>
640 <h4 class=
"discussion">Discussion
</h4>
641 <p class=
"discussion">The returned settings should be freed with cupsFreeOptions() when
642 you are done with them.
645 <h3 class=
"function"><span class=
"info"> CUPS
1.3/macOS
10.5 </span><a id=
"cupsAdminSetServerSettings">cupsAdminSetServerSettings
</a></h3>
646 <p class=
"description">Set settings on the server.
</p>
648 int cupsAdminSetServerSettings(http_t *http, int num_settings, cups_option_t *settings);
</p>
649 <h4 class=
"parameters">Parameters
</h4>
650 <table class=
"list"><tbody>
652 <td class=
"description">Connection to server or
<code>CUPS_HTTP_DEFAULT
</code></td></tr>
653 <tr><th>num_settings
</th>
654 <td class=
"description">Number of settings
</td></tr>
655 <tr><th>settings
</th>
656 <td class=
"description">Settings
</td></tr>
658 <h4 class=
"returnvalue">Return Value
</h4>
659 <p class=
"description">1 on success,
0 on failure
</p>
660 <h3 class=
"function"><span class=
"info"> DEPRECATED
 </span><a id=
"cupsGetDevices">cupsGetDevices
</a></h3>
661 <p class=
"description">Get available printer devices.
</p>
663 ipp_status_t cupsGetDevices(http_t *http, int timeout, const char *include_schemes, const char *exclude_schemes,
<a href=
"#cups_device_cb_t">cups_device_cb_t
</a> callback, void *user_data);
</p>
664 <h4 class=
"parameters">Parameters
</h4>
665 <table class=
"list"><tbody>
667 <td class=
"description">Connection to server or
<code>CUPS_HTTP_DEFAULT
</code></td></tr>
669 <td class=
"description">Timeout in seconds or
<code>CUPS_TIMEOUT_DEFAULT
</code></td></tr>
670 <tr><th>include_schemes
</th>
671 <td class=
"description">Comma-separated URI schemes to include or
<code>CUPS_INCLUDE_ALL
</code></td></tr>
672 <tr><th>exclude_schemes
</th>
673 <td class=
"description">Comma-separated URI schemes to exclude or
<code>CUPS_EXCLUDE_NONE
</code></td></tr>
674 <tr><th>callback
</th>
675 <td class=
"description">Callback function
</td></tr>
676 <tr><th>user_data
</th>
677 <td class=
"description">User data pointer
</td></tr>
679 <h4 class=
"returnvalue">Return Value
</h4>
680 <p class=
"description">Request status -
<code>IPP_OK
</code> on success.
</p>
681 <h4 class=
"discussion">Discussion
</h4>
682 <p class=
"discussion">This function sends a CUPS-Get-Devices request and streams the discovered
683 devices to the specified callback function. The
"timeout
" parameter controls
684 how long the request lasts, while the
"include_schemes
" and
"exclude_schemes
"
685 parameters provide comma-delimited lists of backends to include or omit from
686 the request respectively.
<br>
688 This function is deprecated with the IPP printer discovery functionality
689 being provided by the
<a href=
"#cupsEnumDests"><code>cupsEnumDests
</code></a> and @cupsGetDests@ functions.
692 <h2 class=
"title"><a id=
"TYPES">Data Types
</a></h2>
693 <h3 class=
"typedef"><a id=
"cups_device_cb_t"><span class=
"info"> CUPS
1.4/macOS
10.6 </span>cups_device_cb_t
</a></h3>
694 <p class=
"description">Device callback
697 typedef void (*cups_device_cb_t)(const char *device_class, const char *device_id, const char *device_info, const char *device_make_and_model, const char *device_uri, const char *device_location, void *user_data);