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

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