]> git.ipfire.org Git - thirdparty/cups.git/blame - doc/help/ref-snmp-conf.html
Merge changes from CUPS 1.4svn-r8628.
[thirdparty/cups.git] / doc / help / ref-snmp-conf.html
CommitLineData
89d46774 1<HTML>
2<!-- SECTION: References -->
3<HEAD>
4 <TITLE>snmp.conf</TITLE>
178cb736 5 <LINK REL="STYLESHEET" TYPE="text/css" HREF="../cups-printable.css">
89d46774 6</HEAD>
7<BODY>
8
178cb736
MS
9<H1 CLASS="title">snmp.conf</H1>
10
89d46774 11<P>The <VAR>/etc/cups/snmp.conf</VAR> file contains several
12directives that determine how the SNMP printer discovery backend
13behaves. Each directive is listed on a line by itself followed
14by its value. Comments are introduced using the number sign ("#")
15character at the beginning of a line.</P>
16
17<P>The SNMP backend uses the SNMPv1 protocol to discover network
18printers, collecting information from the Host MIB along with
19intelligent port probes to determine the correct device URI and
20make and model for each printer. Future versions of CUPS will
21likely support the new Port Monitor MIB as well.</P>
22
23<H2 CLASS="title"><A NAME="Address">Address</A></H2>
24
25<H3>Examples</H3>
26
27<PRE CLASS="command">
28Address @LOCAL
29Address @IF(name)
30Address 255.255.255.255
31Address 192.168.2.255
32</PRE>
33
34<H3>Description</H3>
35
36<P>The <CODE>Address</CODE> directive specifies a broadcast
37address to use when discovering printers. Multiple
38<CODE>Address</CODE> lines can be provided to scan different
39subnets.</P>
40
41<P>The default address is <VAR>@LOCAL</VAR>, which broadcasts to
42all LANs.</P>
43
44
45<H2 CLASS="title"><A NAME="Community">Community</A></H2>
46
47<H3>Examples</H3>
48
49<PRE CLASS="command">
50Community public
51Community easysw
52Community BigCorp
53</PRE>
54
55<H3>Description</H3>
56
57<P>The <CODE>Community</CODE> directive specifies a community
58name to use when discovering printers. Multiple
59<CODE>Community</CODE> lines can be provided to scan different
60SNMP communities.</P>
61
62<P>The default community is "public".</P>
63
64
65<H2 CLASS="title"><A NAME="DebugLevel">DebugLevel</A></H2>
66
67<H3>Examples</H3>
68
69<PRE CLASS="command">
70DebugLevel 0
71DebugLevel 1
72DebugLevel 2
73DebugLevel 3
74</PRE>
75
76<H3>Description</H3>
77
78<P>The <CODE>DebugLevel</CODE> directive specifies the debugging
79level to use when searching for network printers. Level 0
80produces no debugging information. Level 1 produces basic
81debugging information. Level 2 adds printing of the SNMP
82messages. Level 3 adds a hex dump of the network data.</P>
83
84<P>The default setting is <VAR>0</VAR>.</P>
85
b94498cf 86<H2 CLASS="title"><A NAME="DeviceURI">DeviceURI</A></H2>
87
88<H3>Examples</H3>
89
90<PRE CLASS="command">
91DeviceURI "HP.*JetDirect.*" socket://%s:9100 socket://%s:9101 socket://%s:9102
92DeviceURI "HP.*" socket://%s
93DeviceURI "Acme.*Laser.*" lpd://%s/print
94DeviceURI "Xerox.*"
95</PRE>
96
97<H3>Description</H3>
98
99<P>The <CODE>DeviceURI</CODE> directive specifies a regular expression
100(enclosed in double quotes) that is matched against the SNMP device
101description OID returned by a printer. If the description matches the
102regular expression, each device URI that follows the regular expression
103is listed by the backend, with any occurrences of <CODE>%s</CODE>
104replaced by the device's hostname or IP address. If no URIs are listed,
105the device is ignored.</P>
106
107<P>The <CODE>DeviceURI</CODE> directives are processed serially in
108the order specified in the <VAR>snmp.conf</VAR> file until a match
109is found.</P>
110
111
89d46774 112<H2 CLASS="title"><A NAME="HostNameLookups">HostNameLookups</A></H2>
113
114<H3>Examples</H3>
115
116<PRE CLASS="command">
117HostNameLookups on
118HostNameLookups off
119</PRE>
120
121<H3>Description</H3>
122
123<P>The <CODE>HostNameLookups</CODE> directive specifies whether printer
124addresses are converted to hostnames or left as numeric IP addresses.</P>
125
126<P>The default setting is <VAR>off</VAR>.</P>
127
d09495fa 128<H2 CLASS="title"><A NAME="MaxRunTime">MaxRunTime</A></H2>
129
130<H3>Examples</H3>
131
132<PRE CLASS="command">
133MaxRunTime 10
134MaxRunTime 300
135</PRE>
136
137<H3>Description</H3>
138
139<P>The <CODE>MaxRunTime</CODE> directive specifies the maxium
140number of seconds that the SNMP backend will spend looking for
141printer devices on the network.</P>
142
143<P>The default setting is <VAR>10</VAR>.</P>
144
89d46774 145</BODY>
146</HTML>