]> git.ipfire.org Git - thirdparty/cups.git/blame - doc/help/man-cups-snmp.conf.html
Save work.
[thirdparty/cups.git] / doc / help / man-cups-snmp.conf.html
CommitLineData
c277f98c 1<!DOCTYPE HTML>
94436c5a
MS
2<html>
3<!-- SECTION: Man Pages -->
4<head>
5 <link rel="stylesheet" type="text/css" href="../cups-printable.css">
6 <title>snmp.conf(5)</title>
7</head>
8<body>
9<h1 class="title">snmp.conf(5)</h1>
10
11<h2 class="title"><a name="NAME">Name</a></h2>
12snmp.conf - snmp configuration file for cups
13<h2 class="title"><a name="DESCRIPTION">Description</a></h2>
14The <i>snmp.conf</i> file configures how the standard CUPS network backends
15(http, https, ipp, ipps, lpd, snmp, and socket) access printer information using
16SNMPv1 and is normally located in the <i>/etc/cups</i> directory. Each line in
17the file can be a configuration directive, a blank line, or a comment. Comment
18lines start with the # character.
19<p>The Community and DebugLevel directives are used by all backends. The remainder
c277f98c 20apply only to the SNMP backend (<i>cups-snmp(8)</i>).
94436c5a
MS
21<h2 class="title"><a name="DIRECTIVES">Directives</a></h2>
22The following directives are understood by the CUPS network backends. Consult
23the on-line help for detailed descriptions:
2909c66c
MS
24<dl class="man">
25<dt>Address @IF(<i>name</i>)
26<dd style="margin-left: 5.0em"><dt>Address @LOCAL
27<dd style="margin-left: 5.0em"><dt>Address <i>address</i>
28<dd style="margin-left: 5.0em"><br>
c277f98c 29Sends SNMP broadcast queries to the specified address(es). There is no default
94436c5a 30for the broadcast address.
2909c66c
MS
31<dt>Community <i>name</i>
32<dd style="margin-left: 5.0em"><br>
c277f98c 33Specifies the community name to use. Only a single community name may be
94436c5a 34specified. The default community name is "public".
2909c66c
MS
35<dt>DebugLevel number
36<dd style="margin-left: 5.0em"><br>
c277f98c 37Specifies the logging level from 0 (none) to 3 (everything). Typically only used
94436c5a 38for debugging (thus the name). The default debug level is 0.
2909c66c
MS
39<dt>DeviceURI "regular expression" device-uri [... device-uri]
40<dd style="margin-left: 5.0em"><br>
c277f98c 41Specifies one or more device URIs that should be used for a given make and model
94436c5a
MS
42string. The regular expression is used to match the detected make and model, and
43the device URI strings must be of the form "scheme://%s[:port]/[path]", where
44"%s" represents the detected address or hostname. There are no default device
45URI matching rules.
2909c66c
MS
46<dt>HostNameLookups on
47<dd style="margin-left: 5.0em"><dt>HostNameLookups off
48<dd style="margin-left: 5.0em"><br>
c277f98c 49Specifies whether the addresses of printers should be converted to hostnames or
94436c5a 50left as numeric IP addresses. The default is "off".
2909c66c
MS
51<dt>MaxRunTime <i>seconds</i>
52<dd style="margin-left: 5.0em"><br>
c277f98c 53Specifies the maximum number of seconds that the SNMP backend will scan the
94436c5a 54network for printers. The default is 120 seconds (2 minutes).
2909c66c 55</dl>
94436c5a
MS
56<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
57cups-snmp(8),
58<br>
c277f98c 59<a href="http://localhost:631/help">http://localhost:631/help</a>
94436c5a
MS
60<h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
61Copyright 2007-2013 by Apple Inc.
62
63</body>
64</html>