]> git.ipfire.org Git - thirdparty/cups.git/blob - man/cups-snmp.man.in
License change: Apache License, Version 2.0.
[thirdparty/cups.git] / man / cups-snmp.man.in
1 .\"
2 .\" SNMP backend man page for CUPS.
3 .\"
4 .\" Copyright 2012-2014 by Apple Inc.
5 .\"
6 .\" Licensed under Apache License v2.0. See the file "LICENSE" for more information.
7 .\"
8 .TH cups-snmp 8 "CUPS" "10 June 2014" "Apple Inc."
9 .SH NAME
10 snmp \- cups snmp backend
11 .SH SYNOPSIS
12 .B /usr/lib/cups/backend/snmp
13 .I ip-address-or-hostname
14 .br
15 .B /usr/libexec/cups/backend/snmp
16 .I ip-address-or-hostname
17 .br
18 .B lpinfo
19 .B \-v
20 .B \-\-include-schemes
21 snmp
22 .SH DESCRIPTION
23 The CUPS SNMP backend provides legacy discovery and identification of network printers using SNMPv1.
24 When used for discovery through the scheduler, the backend will list all printers that respond to a broadcast SNMPv1 query with the "public" community name.
25 Additional queries are then sent to printers that respond in order to determine the correct device URI, make and model, and other information needed for printing.
26 .LP
27 In the first form, the SNMP backend is run directly by the user to look up the device URI and other information when you have an IP address or hostname.
28 This can be used for programs that need to configure print queues where the user has supplied an address but nothing else.
29 .LP
30 In the second form, the SNMP backend is run indirectly using the
31 .BR lpinfo (8)
32 command.
33 The output provides all printers detected via SNMP on the configured
34 broadcast addresses.
35 \fINote: no broadcast addresses are configured by default.\fR
36 .SH ENVIRONMENT
37 The DebugLevel value can be overridden using the CUPS_DEBUG_LEVEL environment variable.
38 The MaxRunTime value can be overridden using the CUPS_MAX_RUN_TIME environment variable.
39 .SH FILES
40 The SNMP backend reads the \fI/etc/cups/snmp.conf\fR configuration file, if
41 present, to set the default broadcast address, community name, and logging
42 level.
43 .SH CONFORMING TO
44 The CUPS SNMP backend uses the information from the Host, Printer, and Port Monitor MIBs along with some vendor private MIBs and intelligent port probes to determine the correct device URI and make and model for each printer.
45 .SH SEE ALSO
46 .BR backend (7),
47 .BR cups-snmp.conf (5),
48 .BR cupsd (8),
49 .BR lpinfo (8),
50 CUPS Online Help (http://localhost:631/help)
51 .SH COPYRIGHT
52 Copyright \[co] 2007-2017 by Apple Inc.