doc/help/ref-snmp-conf.html

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