]> git.ipfire.org Git - thirdparty/cups.git/blob - man/cups-snmp.man.in
ae07f248db0ae741d674a0151890a064fcaa2fff
[thirdparty/cups.git] / man / cups-snmp.man.in
1 .\"
2 .\" "$Id$"
3 .\"
4 .\" SNMP backend man page for CUPS.
5 .\"
6 .\" Copyright 2012-2013 by Apple Inc.
7 .\"
8 .\" These coded instructions, statements, and computer programs are the
9 .\" property of Apple Inc. and are protected by Federal copyright
10 .\" law. Distribution and use rights are outlined in the file "LICENSE.txt"
11 .\" which should have been included with this file. If this file is
12 .\" file is missing or damaged, see the license at "http://www.cups.org/".
13 .\"
14 .TH cups-snmp 8 "CUPS" "8 July 2013" "Apple Inc."
15 .SH NAME
16 snmp \- cups snmp backend
17 .SH SYNOPSIS
18 .B /usr/lib/cups/backend/snmp
19 .I ip-address-or-hostname
20 .br
21 .B /usr/libexec/cups/backend/snmp
22 .I ip-address-or-hostname
23 .br
24 .B lpinfo -v --include-schemes snmp
25 .SH DESCRIPTION
26 The CUPS SNMP backend provides legacy discovery and identification of network
27 printers using SNMPv1. When used for discovery through the scheduler, the
28 backend will list all printers that respond to a broadcast SNMPv1 query with the
29 "public" community name. Additional queries are then sent to printers that
30 respond in order to determine the correct device URI, make and model, and other
31 information needed for printing.
32 .LP
33 In the first form, the SNMP backend is run directly by the user to look up the
34 device URI and other information when you have an IP address or hostname. This
35 can be used for programs that need to configure print queues where the user has
36 supplied an address but nothing else.
37 .LP
38 In the second form, the SNMP backend is run indirectly using the \fIlpinfo(8)\fR
39 command. The output provides all printers detected via SNMP on the configured
40 broadcast addresses. \fBNote\fR: no broadcast addresses are configured by
41 default.
42 .SH MIBS
43 The CUPS SNMP backend uses the information from the Host, Printer, and Port
44 Monitor MIBs along with some vendor private MIBs and intelligent port probes to
45 determine the correct device URI and make and model for each printer.
46 .SH CONFIGURATION
47 The SNMP backend reads the /etc/cups/snmp.conf configuration file, if
48 present, to set the default broadcast address, community name, and logging
49 level. The configuration file is documented in \fIcups-snmp.conf(5)\fR. The
50 DebugLevel value can be overridden using the CUPS_DEBUG_LEVEL environment
51 variable and the MaxRunTime value can be overridden using the CUPS_MAX_RUN_TIME
52 environment variable.
53 .SH SEE ALSO
54 \fIbackend(7)\fR, \fIcups-snmp.conf(5)\fR, \fIcupsd(8)\fR, \fIcupsd.conf(5)\fR,
55 \fIfilter(7)\fR, \fIlpinfo(8)\fR,
56 .br
57 http://localhost:631/help
58 .SH COPYRIGHT
59 Copyright 2007-2013 by Apple Inc.
60 .\"
61 .\" End of "$Id$".
62 .\"