[thirdparty/cups.git] / man / cups-snmp.conf.man

.\"
.\" snmp.conf man page for CUPS.
.\"
.\" Copyright © 2007-2018 by Apple Inc.
.\" Copyright © 2006 by Easy Software Products.
.\"
.\" Licensed under Apache License v2.0.  See the file "LICENSE" for more
.\" information.
.\"
.TH snmp.conf 5 "CUPS" "8 November 2018" "Apple Inc."
.SH NAME
snmp.conf \- snmp configuration file for cups
.SH DESCRIPTION
The
.B snmp.conf
file configures how the standard CUPS network backends (http, https, ipp, ipps, lpd, snmp, and socket) access printer information using SNMPv1 and is normally located in the \fI/etc/cups\fR directory.
Each line in the file can be a configuration directive, a blank line, or a comment. Comment lines start with the # character.
.LP
The Community and DebugLevel directives are used by all backends. The remainder apply only to the SNMP backend -
.BR cups-snmp (8).
.SH DIRECTIVES
The following directives are understood by the CUPS network backends:
.TP 5
\fBAddress @IF(\fIname\fB)\fR
.TP 5
\fBAddress @LOCAL\fR
.TP 5
\fBAddress \fIaddress\fR
Sends SNMP broadcast queries (for discovery) to the specified address(es).
There is no default for the broadcast address.
.TP 5
\fBCommunity \fIname\fR
Specifies the community name to use.
Only a single community name may be specified.
The default community name is "public".
If no name is specified, all SNMP functions are disabled.
.TP 5
\fBDebugLevel \fInumber\fR
Specifies the logging level from 0 (none) to 3 (everything).
Typically only used for debugging (thus the name).
The default debug level is 0.
.TP 5
\fBDeviceURI "\fIregular expression\fB" \fIdevice-uri \fR[... \fIdevice-uri\fR]
Specifies one or more device URIs that should be used for a given make and model string.
The regular expression is used to match the detected make and model, and the device URI strings must be of the form "scheme://%s[:port]/[path]", where "%s" represents the detected address or hostname.
There are no default device URI matching rules.
.TP 5
\fBHostNameLookups on\fR
.TP 5
\fBHostNameLookups off\fR
Specifies whether the addresses of printers should be converted to hostnames or left as numeric IP addresses.
The default is "off".
.TP 5
\fBMaxRunTime \fIseconds\fR
Specifies the maximum number of seconds that the SNMP backend will scan the
network for printers.
The default is 120 seconds (2 minutes).
.SH SEE ALSO
.BR cups-snmp (8),
CUPS Online Help (http://localhost:631/help)
.SH COPYRIGHT
Copyright \[co] 2007-2018 by Apple Inc.
Commit	Line	Data
	1	.\"
	2	.\" snmp.conf man page for CUPS.
	3	.\"
	4	.\" Copyright © 2007-2018 by Apple Inc.
	5	.\" Copyright © 2006 by Easy Software Products.
	6	.\"
	7	.\" Licensed under Apache License v2.0. See the file "LICENSE" for more
	8	.\" information.
	9	.\"
	10	.TH snmp.conf 5 "CUPS" "8 November 2018" "Apple Inc."
	11	.SH NAME
	12	snmp.conf \- snmp configuration file for cups
	13	.SH DESCRIPTION
	14	The
	15	.B snmp.conf
	16	file configures how the standard CUPS network backends (http, https, ipp, ipps, lpd, snmp, and socket) access printer information using SNMPv1 and is normally located in the \fI/etc/cups\fR directory.
	17	Each line in the file can be a configuration directive, a blank line, or a comment. Comment lines start with the # character.
	18	.LP
	19	The Community and DebugLevel directives are used by all backends. The remainder apply only to the SNMP backend -
	20	.BR cups-snmp (8).
	21	.SH DIRECTIVES
	22	The following directives are understood by the CUPS network backends:
	23	.TP 5
	24	\fBAddress @IF(\fIname\fB)\fR
	25	.TP 5
	26	\fBAddress @LOCAL\fR
	27	.TP 5
	28	\fBAddress \fIaddress\fR
	29	Sends SNMP broadcast queries (for discovery) to the specified address(es).
	30	There is no default for the broadcast address.
	31	.TP 5
	32	\fBCommunity \fIname\fR
	33	Specifies the community name to use.
	34	Only a single community name may be specified.
	35	The default community name is "public".
	36	If no name is specified, all SNMP functions are disabled.
	37	.TP 5
	38	\fBDebugLevel \fInumber\fR
	39	Specifies the logging level from 0 (none) to 3 (everything).
	40	Typically only used for debugging (thus the name).
	41	The default debug level is 0.
	42	.TP 5
	43	\fBDeviceURI "\fIregular expression\fB" \fIdevice-uri \fR[... \fIdevice-uri\fR]
	44	Specifies one or more device URIs that should be used for a given make and model string.
	45	The regular expression is used to match the detected make and model, and the device URI strings must be of the form "scheme://%s[:port]/[path]", where "%s" represents the detected address or hostname.
	46	There are no default device URI matching rules.
	47	.TP 5
	48	\fBHostNameLookups on\fR
	49	.TP 5
	50	\fBHostNameLookups off\fR
	51	Specifies whether the addresses of printers should be converted to hostnames or left as numeric IP addresses.
	52	The default is "off".
	53	.TP 5
	54	\fBMaxRunTime \fIseconds\fR
	55	Specifies the maximum number of seconds that the SNMP backend will scan the
	56	network for printers.
	57	The default is 120 seconds (2 minutes).
	58	.SH SEE ALSO
	59	.BR cups-snmp (8),
	60	CUPS Online Help (http://localhost:631/help)
	61	.SH COPYRIGHT
	62	Copyright \[co] 2007-2018 by Apple Inc.