doc/help/man-cups-snmp.conf.html

   1 <!DOCTYPE HTML>
   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>
  12 snmp.conf - snmp configuration file for cups
  13 <h2 class="title"><a name="DESCRIPTION">Description</a></h2>
  14 The <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
  16 SNMPv1 and is normally located in the <i>/etc/cups</i> directory. Each line in
  17 the file can be a configuration directive, a blank line, or a comment. Comment
  18 lines start with the # character.
  19 <p>The Community and DebugLevel directives are used by all backends. The remainder
  20 apply only to the SNMP backend (<i>cups-snmp(8)</i>).
  21 <h2 class="title"><a name="DIRECTIVES">Directives</a></h2>
  22 The following directives are understood by the CUPS network backends. Consult
  23 the on-line help for detailed descriptions:
  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>
  29 Sends SNMP broadcast queries to the specified address(es). There is no default
  30 for the broadcast address.
  31 <dt>Community <i>name</i>
  32 <dd style="margin-left: 5.0em"><br>
  33 Specifies the community name to use. Only a single community name may be
  34 specified. The default community name is "public".
  35 <dt>DebugLevel number
  36 <dd style="margin-left: 5.0em"><br>
  37 Specifies the logging level from 0 (none) to 3 (everything). Typically only used
  38 for debugging (thus the name). The default debug level is 0.
  39 <dt>DeviceURI "regular expression" device-uri [... device-uri]
  40 <dd style="margin-left: 5.0em"><br>
  41 Specifies one or more device URIs that should be used for a given make and model
  42 string. The regular expression is used to match the detected make and model, and
  43 the 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
  45 URI matching rules.
  46 <dt>HostNameLookups on
  47 <dd style="margin-left: 5.0em"><dt>HostNameLookups off
  48 <dd style="margin-left: 5.0em"><br>
  49 Specifies whether the addresses of printers should be converted to hostnames or
  50 left as numeric IP addresses. The default is "off".
  51 <dt>MaxRunTime <i>seconds</i>
  52 <dd style="margin-left: 5.0em"><br>
  53 Specifies the maximum number of seconds that the SNMP backend will scan the
  54 network for printers. The default is 120 seconds (2 minutes).
  55 </dl>
  56 <h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
  57 cups-snmp(8),
  58 <br>
  59 <a href="http://localhost:631/help">http://localhost:631/help</a>
  60 <h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
  61 Copyright 2007-2013 by Apple Inc.
  62
  63 </body>
  64 </html>