]> git.ipfire.org Git - thirdparty/cups.git/blame - doc/help/man-cups-snmp.conf.html
Update .gitignore to ignore compressed man pages.
[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>
94436c5a
MS
10<h2 class="title"><a name="NAME">Name</a></h2>
11snmp.conf - snmp configuration file for cups
12<h2 class="title"><a name="DESCRIPTION">Description</a></h2>
ce0ddeb2
MS
13The
14<b>snmp.conf</b>
15file 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.
16Each line in the file can be a configuration directive, a blank line, or a comment. Comment lines start with the # character.
17<p>The Community and DebugLevel directives are used by all backends. The remainder apply only to the SNMP backend -
18<a href="man-cups-snmp.html?TOPIC=Man+Pages"><b>cups-snmp</b>(8).</a>
94436c5a 19<h2 class="title"><a name="DIRECTIVES">Directives</a></h2>
ce0ddeb2 20The following directives are understood by the CUPS network backends:
2909c66c 21<dl class="man">
ce0ddeb2
MS
22<dt><b>Address @IF(</b><i>name</i><b>)</b>
23<dd style="margin-left: 5.0em"><dt><b>Address @LOCAL</b>
24<dd style="margin-left: 5.0em"><dt><b>Address </b><i>address</i>
25<dd style="margin-left: 5.0em">Sends SNMP broadcast queries (for discovery) to the specified address(es).
26There is no default for the broadcast address.
27<dt><b>Community </b><i>name</i>
28<dd style="margin-left: 5.0em">Specifies the community name to use.
29Only a single community name may be specified.
30The default community name is "public".
51c22b86 31If no name is specified, all SNMP functions are disabled.
ce0ddeb2
MS
32<dt><b>DebugLevel </b><i>number</i>
33<dd style="margin-left: 5.0em">Specifies the logging level from 0 (none) to 3 (everything).
34Typically only used for debugging (thus the name).
35The default debug level is 0.
36<dt><b>DeviceURI "</b><i>regular expression</i><b>" </b><i>device-uri </i>[... <i>device-uri</i>]
37<dd style="margin-left: 5.0em">Specifies one or more device URIs that should be used for a given make and model string.
38The 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.
39There are no default device URI matching rules.
40<dt><b>HostNameLookups on</b>
41<dd style="margin-left: 5.0em"><dt><b>HostNameLookups off</b>
42<dd style="margin-left: 5.0em">Specifies whether the addresses of printers should be converted to hostnames or left as numeric IP addresses.
43The default is "off".
44<dt><b>MaxRunTime </b><i>seconds</i>
45<dd style="margin-left: 5.0em">Specifies the maximum number of seconds that the SNMP backend will scan the
46network for printers.
47The default is 120 seconds (2 minutes).
2909c66c 48</dl>
94436c5a 49<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
ce0ddeb2
MS
50<a href="man-cups-snmp.html?TOPIC=Man+Pages"><b>cups-snmp</b>(8),</a>
51CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>)
94436c5a 52<h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
afad2da2 53Copyright &copy; 2007-2018 by Apple Inc.
94436c5a
MS
54
55</body>
56</html>