xref: /aosp_15_r20/external/libcups/doc/help/man-cups-snmp.conf.html (revision 5e7646d21f1134fb0638875d812ef646c12ab91e)
1*5e7646d2SAndroid Build Coastguard Worker<!DOCTYPE HTML>
2*5e7646d2SAndroid Build Coastguard Worker<html>
3*5e7646d2SAndroid Build Coastguard Worker<!-- SECTION: Man Pages -->
4*5e7646d2SAndroid Build Coastguard Worker<head>
5*5e7646d2SAndroid Build Coastguard Worker	<link rel="stylesheet" type="text/css" href="../cups-printable.css">
6*5e7646d2SAndroid Build Coastguard Worker	<title>snmp.conf(5)</title>
7*5e7646d2SAndroid Build Coastguard Worker</head>
8*5e7646d2SAndroid Build Coastguard Worker<body>
9*5e7646d2SAndroid Build Coastguard Worker<h1 class="title">snmp.conf(5)</h1>
10*5e7646d2SAndroid Build Coastguard Worker<h2 class="title"><a name="NAME">Name</a></h2>
11*5e7646d2SAndroid Build Coastguard Workersnmp.conf - snmp configuration file for cups (deprecated)
12*5e7646d2SAndroid Build Coastguard Worker<h2 class="title"><a name="DESCRIPTION">Description</a></h2>
13*5e7646d2SAndroid Build Coastguard WorkerThe
14*5e7646d2SAndroid Build Coastguard Worker<b>snmp.conf</b>
15*5e7646d2SAndroid Build Coastguard Workerfile configures how the standard CUPS network backends (http, https, ipp, ipps, lpd, snmp, and socket) access printer information using SNMPv1 and is normally located in the <i>/etc/cups</i> directory.
16*5e7646d2SAndroid Build Coastguard WorkerEach line in the file can be a configuration directive, a blank line, or a comment. Comment lines start with the # character.
17*5e7646d2SAndroid Build Coastguard Worker<p>The Community and DebugLevel directives are used by all backends. The remainder apply only to the SNMP backend -
18*5e7646d2SAndroid Build Coastguard Worker<b>cups-snmp</b>(8).
19*5e7646d2SAndroid Build Coastguard Worker<h2 class="title"><a name="DIRECTIVES">Directives</a></h2>
20*5e7646d2SAndroid Build Coastguard WorkerThe following directives are understood by the CUPS network backends:
21*5e7646d2SAndroid Build Coastguard Worker<dl class="man">
22*5e7646d2SAndroid Build Coastguard Worker<dt><b>Address @IF(</b><i>name</i><b>)</b>
23*5e7646d2SAndroid Build Coastguard Worker<dd style="margin-left: 5.0em"><dt><b>Address @LOCAL</b>
24*5e7646d2SAndroid Build Coastguard Worker<dd style="margin-left: 5.0em"><dt><b>Address </b><i>address</i>
25*5e7646d2SAndroid Build Coastguard Worker<dd style="margin-left: 5.0em">Sends SNMP broadcast queries (for discovery) to the specified address(es).
26*5e7646d2SAndroid Build Coastguard WorkerThere is no default for the broadcast address.
27*5e7646d2SAndroid Build Coastguard Worker<dt><b>Community </b><i>name</i>
28*5e7646d2SAndroid Build Coastguard Worker<dd style="margin-left: 5.0em">Specifies the community name to use.
29*5e7646d2SAndroid Build Coastguard WorkerOnly a single community name may be specified.
30*5e7646d2SAndroid Build Coastguard WorkerThe default community name is "public".
31*5e7646d2SAndroid Build Coastguard WorkerIf no name is specified, all SNMP functions are disabled.
32*5e7646d2SAndroid Build Coastguard Worker<dt><b>DebugLevel </b><i>number</i>
33*5e7646d2SAndroid Build Coastguard Worker<dd style="margin-left: 5.0em">Specifies the logging level from 0 (none) to 3 (everything).
34*5e7646d2SAndroid Build Coastguard WorkerTypically only used for debugging (thus the name).
35*5e7646d2SAndroid Build Coastguard WorkerThe default debug level is 0.
36*5e7646d2SAndroid Build Coastguard Worker<dt><b>DeviceURI "</b><i>regular expression</i><b>" </b><i>device-uri </i>[... <i>device-uri</i>]
37*5e7646d2SAndroid Build Coastguard Worker<dd style="margin-left: 5.0em">Specifies one or more device URIs that should be used for a given make and model string.
38*5e7646d2SAndroid Build Coastguard WorkerThe regular expression is used to match the detected make and model, and the device URI strings must be of the form "scheme://%s[:port]/[path]", where "%s" represents the detected address or hostname.
39*5e7646d2SAndroid Build Coastguard WorkerThere are no default device URI matching rules.
40*5e7646d2SAndroid Build Coastguard Worker<dt><b>HostNameLookups on</b>
41*5e7646d2SAndroid Build Coastguard Worker<dd style="margin-left: 5.0em"><dt><b>HostNameLookups off</b>
42*5e7646d2SAndroid Build Coastguard Worker<dd style="margin-left: 5.0em">Specifies whether the addresses of printers should be converted to hostnames or left as numeric IP addresses.
43*5e7646d2SAndroid Build Coastguard WorkerThe default is "off".
44*5e7646d2SAndroid Build Coastguard Worker<dt><b>MaxRunTime </b><i>seconds</i>
45*5e7646d2SAndroid Build Coastguard Worker<dd style="margin-left: 5.0em">Specifies the maximum number of seconds that the SNMP backend will scan the
46*5e7646d2SAndroid Build Coastguard Workernetwork for printers.
47*5e7646d2SAndroid Build Coastguard WorkerThe default is 120 seconds (2 minutes).
48*5e7646d2SAndroid Build Coastguard Worker</dl>
49*5e7646d2SAndroid Build Coastguard Worker<h2 class="title"><a name="NOTES">Notes</a></h2>
50*5e7646d2SAndroid Build Coastguard WorkerCUPS backends are deprecated and will no longer be supported in a future feature release of CUPS.
51*5e7646d2SAndroid Build Coastguard WorkerPrinters that do not support IPP can be supported using applications such as
52*5e7646d2SAndroid Build Coastguard Worker<b>ippeveprinter</b>(1).
53*5e7646d2SAndroid Build Coastguard Worker<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
54*5e7646d2SAndroid Build Coastguard Worker<b>cups-snmp</b>(8),
55*5e7646d2SAndroid Build Coastguard WorkerCUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>)
56*5e7646d2SAndroid Build Coastguard Worker<h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
57*5e7646d2SAndroid Build Coastguard WorkerCopyright &copy; 2007-2019 by Apple Inc.
58*5e7646d2SAndroid Build Coastguard Worker
59*5e7646d2SAndroid Build Coastguard Worker</body>
60*5e7646d2SAndroid Build Coastguard Worker</html>
61