[thirdparty/cups.git] / doc / help / ref-snmp-conf.html

<HTML>
<!-- SECTION: References -->
<HEAD>
	<TITLE>snmp.conf</TITLE>
</HEAD>
<BODY>

<P>The <VAR>/etc/cups/snmp.conf</VAR> file contains several
directives that determine how the SNMP printer discovery backend
behaves. Each directive is listed on a line by itself followed
by its value. Comments are introduced using the number sign ("#")
character at the beginning of a line.</P>

<P>The SNMP backend uses the SNMPv1 protocol to discover network
printers, collecting information from the Host MIB along with
intelligent port probes to determine the correct device URI and
make and model for each printer. Future versions of CUPS will
likely support the new Port Monitor MIB as well.</P>

<H2 CLASS="title"><A NAME="Address">Address</A></H2>

<H3>Examples</H3>

<PRE CLASS="command">
Address @LOCAL
Address @IF(name)
Address 255.255.255.255
Address 192.168.2.255
</PRE>

<H3>Description</H3>

<P>The <CODE>Address</CODE> directive specifies a broadcast
address to use when discovering printers. Multiple
<CODE>Address</CODE> lines can be provided to scan different
subnets.</P>

<P>The default address is <VAR>@LOCAL</VAR>, which broadcasts to
all LANs.</P>


<H2 CLASS="title"><A NAME="Community">Community</A></H2>

<H3>Examples</H3>

<PRE CLASS="command">
Community public
Community easysw
Community BigCorp
</PRE>

<H3>Description</H3>

<P>The <CODE>Community</CODE> directive specifies a community
name to use when discovering printers. Multiple
<CODE>Community</CODE> lines can be provided to scan different
SNMP communities.</P>

<P>The default community is "public".</P>


<H2 CLASS="title"><A NAME="DebugLevel">DebugLevel</A></H2>

<H3>Examples</H3>

<PRE CLASS="command">
DebugLevel 0
DebugLevel 1
DebugLevel 2
DebugLevel 3
</PRE>

<H3>Description</H3>

<P>The <CODE>DebugLevel</CODE> directive specifies the debugging
level to use when searching for network printers. Level 0
produces no debugging information. Level 1 produces basic
debugging information. Level 2 adds printing of the SNMP
messages. Level 3 adds a hex dump of the network data.</P>

<P>The default setting is <VAR>0</VAR>.</P>

<H2 CLASS="title"><A NAME="DeviceURI">DeviceURI</A></H2>

<H3>Examples</H3>

<PRE CLASS="command">
DeviceURI "HP.*JetDirect.*" socket://%s:9100 socket://%s:9101 socket://%s:9102
DeviceURI "HP.*" socket://%s
DeviceURI "Acme.*Laser.*" lpd://%s/print
DeviceURI "Xerox.*"
</PRE>

<H3>Description</H3>

<P>The <CODE>DeviceURI</CODE> directive specifies a regular expression
(enclosed in double quotes) that is matched against the SNMP device
description OID returned by a printer. If the description matches the
regular expression, each device URI that follows the regular expression
is listed by the backend, with any occurrences of <CODE>%s</CODE>
replaced by the device's hostname or IP address. If no URIs are listed,
the device is ignored.</P>

<P>The <CODE>DeviceURI</CODE> directives are processed serially in
the order specified in the <VAR>snmp.conf</VAR> file until a match
is found.</P>


<H2 CLASS="title"><A NAME="HostNameLookups">HostNameLookups</A></H2>

<H3>Examples</H3>

<PRE CLASS="command">
HostNameLookups on
HostNameLookups off
</PRE>

<H3>Description</H3>

<P>The <CODE>HostNameLookups</CODE> directive specifies whether printer
addresses are converted to hostnames or left as numeric IP addresses.</P>

<P>The default setting is <VAR>off</VAR>.</P>

<H2 CLASS="title"><A NAME="MaxRunTime">MaxRunTime</A></H2>

<H3>Examples</H3>

<PRE CLASS="command">
MaxRunTime 10
MaxRunTime 300
</PRE>

<H3>Description</H3>

<P>The <CODE>MaxRunTime</CODE> directive specifies the maxium
number of seconds that the SNMP backend will spend looking for
printer devices on the network.</P>

<P>The default setting is <VAR>10</VAR>.</P>

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