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