Automatically generated by Pod::Man 4.10 (Pod::Simple 3.35) Standard preamble: ========================================================================..
..
..
Set up some character translations and predefined strings. \*(-- will give an unbreakable dash, \*(PI will give pi, \*(L" will give a left double quote, and \*(R" will give a right double quote. \*(C+ will give a nicer C++. Capital omega is used to do unbreakable dashes and therefore won't be available. \*(C` and \*(C' expand to `' in nroff, nothing in troff, for use with C<>..tr \(*W-
. ds -- \(*W-
. ds PI pi
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
. ds L" ""
. ds R" ""
. ds C` ""
. ds C' ""
'br\}
. ds -- \|\(em\|
. ds PI \(*p
. ds L" ``
. ds R" ''
. ds C`
. ds C'
'br\}
Escape single quotes in literal strings from groff's Unicode transform. If the F register is >0, we'll generate index entries on stderr for titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index entries marked with X<> in POD. Of course, you'll have to process the output yourself in some meaningful fashion. Avoid warning from groff about undefined register 'F'...
.nr rF 0
. if \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. if !\nF==2 \{\
. nr % 0
. nr F 2
. \}
. \}
.\}
.rr rF
Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). Fear. Run. Save yourself. No user-serviceable parts.. \" fudge factors for nroff and troff
. ds #H 0
. ds #V .8m
. ds #F .3m
. ds #[ \f1
. ds #]
.\}
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
. ds #V .6m
. ds #F 0
. ds #[ \&
. ds #] \&
.\}
. \" simple accents for nroff and troff
. ds ' \&
. ds ` \&
. ds ^ \&
. ds , \&
. ds ~ ~
. ds /
.\}
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
. \" troff and (daisy-wheel) nroff accents
. \" corrections for vroff
. \" for low resolution devices (crt and lpr)
\{\
. ds : e
. ds 8 ss
. ds o a
. ds d- d\h'-1'\(ga
. ds D- D\h'-1'\(hy
. ds th \o'bp'
. ds Th \o'LP'
. ds ae ae
. ds Ae AE
.\}
======================================================================== Title "COLLECTD-SNMP 5" COLLECTD-SNMP 5 "2020-09-03" "5.12.0" "collectd"
For nroff, turn off justification. Always turn off hyphenation; it makes way too many mistakes in technical documents. "NAME"
collectd-snmp - Documentation of collectd's "snmp plugin"
"SYNOPSIS"
Header "SYNOPSIS" .Vb 10
LoadPlugin snmp
# ...
<Plugin snmp>
<Data "powerplus_voltge_input">
Table false
Type "voltage"
TypeInstance "input_line1"
Scale 0.1
Values "SNMPv2-SMI::enterprises.6050.5.4.1.1.2.1"
</Data>
<Data "hr_users">
Table false
Type "users"
Shift -1
Values "HOST-RESOURCES-MIB::hrSystemNumUsers.0"
</Data>
<Data "std_traffic">
Table true
Type "if_octets"
TypeInstanceOID "IF-MIB::ifDescr"
#FilterOID "IF-MIB::ifOperStatus"
#FilterValues "1", "2"
Values "IF-MIB::ifInOctets" "IF-MIB::ifOutOctets"
</Data>
<Data "lancom_stations_total">
Type "counter"
PluginInstance "stations_total"
Table true
Count true
Values "SNMPv2-SMI::enterprises.2356.11.1.3.32.1.10" # SNMPv2-SMI::enterprises.lancom-systems.lcos.lcsStatus.lcsStatusWlan.lcsStatusWlanStationTableTable.lcsStatusWlanStationTableEntry.lcsStatusWlanStationTableEntryState
</Data>
<Data "lancom_stations_connected">
Type "counter"
PluginInstance "stations_connected"
Table true
Count true
Values "SNMPv2-SMI::enterprises.2356.11.1.3.32.1.10" # SNMPv2-SMI::enterprises.lancom-systems.lcos.lcsStatus.lcsStatusWlan.lcsStatusWlanStationTableTable.lcsStatusWlanStationTableEntry.lcsStatusWlanStationTableEntryState
FilterOID "SNMPv2-SMI::enterprises.2356.11.1.3.32.1.10"
FilterValues "3" # eConnected
</Data>
\&
<Host "
some.switch.mydomain.org">
Address "192.168.0.2"
Version 1
Community "community_string"
Collect "std_traffic"
Interval 120
Timeout 10
Retries 1
</Host>
<Host "
some.server.mydomain.org">
Address "192.168.0.42"
Version 2
Community "another_string"
Collect "std_traffic" "hr_users"
</Host>
<Host "secure.router.mydomain.org">
Address "192.168.0.7:165"
Version 3
SecurityLevel "authPriv"
Username "cosmo"
AuthProtocol "SHA"
AuthPassphrase "setec_astronomy"
PrivacyProtocol "AES"
PrivacyPassphrase "too_many_secrets"
Collect "std_traffic"
</Host>
<Host "some.ups.mydomain.org">
Address "tcp:192.168.0.3"
Version 1
Community "more_communities"
Collect "powerplus_voltge_input"
Interval 300
Timeout 5
Retries 5
</Host>
</Plugin>
.Ve
"DESCRIPTION"
Header "DESCRIPTION" The
\*(C`snmp plugin\*(C' queries other hosts using \s-1SNMP,\s0 the simple network
management protocol, and translates the value it receives to collectd's
internal format and dispatches them. Depending on the write plugins you have
loaded they may be written to disk or submitted to another instance or
whatever you configured.
Because querying a host via \s-1SNMP\s0 may produce a timeout the \*(L"complex reads\*(R"
polling method is used. The ReadThreads parameter in the main configuration
influences the number of parallel polling jobs which can be undertaken. If
you expect timeouts or some polling to take a long time, you should increase
this parameter. Note that other plugins also use the same threads.
"CONFIGURATION"
Header "CONFIGURATION" Since the aim of the
\*(C`snmp plugin\*(C' is to provide a generic interface to \s-1SNMP,\s0
its configuration is not trivial and may take some time.
Since the \*(C`Net-SNMP\*(C' library is used you can use all the environment variables
that are interpreted by that package. See snmpcmd\|(1) for more details.
There are two types of blocks that can be contained in the
\f(CW\*(C`<Plugin snmp>\*(C' block: Data and Host:
"The Data block"
Subsection "The Data block" The
Data block defines a list of values or a table of values that are to be
queried. The following options can be set:
"Type type" 4
Item "Type type" collectd's type that is to be used, e. g. \*(L"if_octets\*(R" for interface
traffic or \*(L"users\*(R" for a user count. The types are read from the
TypesDB
(see
collectd.conf\|(5)), so you may want to check for which types are
defined. See
types.db\|(5) for a description of the format of this file.
"Table true|false" 4
Item "Table true|false" Define if this is a single list of values or a table of values. The difference
is the following:
.Sp
When
Table is set to
false, the OIDs given to
Values (see below) are
queried using the
\*(C`GET\*(C' \s-1SNMP\s0 command (see
snmpget\|(1)) and transmitted to
collectd.
One value list is dispatched and, eventually, one file will be
written.
.Sp
When
Table is set to
true, the OIDs given to
Values,
TypeInstanceOID,
\fBPluginInstanceOID,
HostOID and
FilterOID (see below) are queried using
the
\*(C`GETNEXT\*(C' \s-1SNMP\s0 command until the subtree is left. After all the lists
(think: all columns of the table) have been read, either (
Count set to
false)
\fBseveral value sets will be dispatched and, eventually, several files will be
written, or (
Count set to
true) one single value will be dispatched. If you
configure a
Type (see above) which needs more than one data source (for
example
\*(C`if_octets\*(C' which needs
\*(C`rx\*(C' and
\*(C`tx\*(C') you will need to specify more
than one (two, in the example case) OIDs with the
Values option and can't use
the
Count option. This has nothing to do with the
Table setting.
.Sp
For example, if you want to query the number of users on a system, you can use
\f(CW\*(C`HOST-RESOURCES-MIB::hrSystemNumUsers.0\*(C'. This is one value and belongs to one
value list, therefore
Table must be set to
false. Please note that, in
this case, you have to include the sequence number (zero in this case) in the
\s-1OID.\s0
.Sp
Counter example: If you want to query the interface table provided by the
\f(CW\*(C`IF-MIB\*(C', e. g. the bytes transmitted. There are potentially many
interfaces, so you will want to set
Table to
true. Because the
\f(CW\*(C`if_octets\*(C' type needs two values, received and transmitted bytes, you need to
specify two OIDs in the
Values setting, in this case likely
\f(CW\*(C`IF-MIB::ifHCInOctets\*(C' and
\*(C`IF-MIB::ifHCOutOctets\*(C'. But, this is because of
the
Type setting, not the
Table setting.
.Sp
Since the semantic of
Instance and
Values depends on this setting you
need to set it before setting them. Doing vice versa will result in undefined
behavior.
"Plugin Plugin" 4
Item "Plugin Plugin" Use
Plugin as the plugin name of the values that are dispatched.
Defaults to
\*(C`snmp\*(C'.
"PluginInstance Instance" 4
Item "PluginInstance Instance" Sets the plugin-instance of the values that are dispatched to
Instance value.
.Sp
When
Table is set to
true and
PluginInstanceOID is set then this option
has no effect.
.Sp
Defaults to an empty string.
"TypeInstance Instance" 4
Item "TypeInstance Instance" Sets the type-instance of the values that are dispatched to
Instance value.
.Sp
When
Table is set to
true and
TypeInstanceOID is set then this option
has no effect.
.Sp
Defaults to an empty string.
"TypeInstanceOID \s-1OID\s0" 4
Item "TypeInstanceOID OID" 0
"PluginInstanceOID \s-1OID\s0" 4
Item "PluginInstanceOID OID" "HostOID \s-1OID\s0" 4
Item "HostOID OID"
If Table is set to true, \s-1OID\s0 is interpreted as an SNMP-prefix that will
return a list of values. Those values are then used as the actual type-instance,
plugin-instance or host of dispatched metrics. An example would be the
\f(CW\*(C`IF-MIB::ifDescr\*(C' subtree. variables\|(5) from the \s-1SNMP\s0 distribution describes
the format of OIDs. When option is set to empty string, then \*(L"\s-1SUBID\*(R"\s0 will be used
as the value.
.Sp
Prefix may be set for values with use of appropriate TypeInstancePrefix,
\fBPluginInstancePrefix and HostPrefix options.
.Sp
When Table is set to false or Count is set to true, these options
have no effect.
.Sp
Defaults: When no one of these options is configured explicitly,
\fBTypeInstanceOID defaults to an empty string.
"TypeInstancePrefix" 4
Item "TypeInstancePrefix" 0
"PluginInstancePrefix" 4
Item "PluginInstancePrefix" "HostPrefix" 4
Item "HostPrefix"
These options are intented to be used together with TypeInstanceOID,
\fBPluginInstanceOID and HostOID respectively.
.Sp
If set, String is preprended to values received by querying the agent.
.Sp
When Table is set to false or Count is set to true, these options
have no effect.
.Sp
The \*(C`UPS-MIB\*(C' is an example where you need this setting: It has voltages of
the inlets, outlets and the battery of an \s-1UPS.\s0 However, it doesn't provide a
descriptive column for these voltages. In this case having 1, 2, ... as
instances is not enough, because the inlet voltages and outlet voltages may
both have the subids 1, 2, ... You can use this setting to distinguish
between the different voltages.
"Instance Instance" 4
Item "Instance Instance" Attention: this option exists for backwards compatibility only and will be
removed in next major release. Please use
TypeInstance /
TypeInstanceOID
instead.
.Sp
The meaning of this setting depends on whether
Table is set to
true or
\fIfalse.
.Sp
If
Table is set to
true, option behaves as
TypeInstanceOID.
If
Table is set to
false, option behaves as
TypeInstance.
.Sp
Note what
Table option must be set before setting
Instance.
"InstancePrefix String" 4
Item "InstancePrefix String" Attention: this option exists for backwards compatibility only and will be
removed in next major release. Please use
TypeInstancePrefix instead.
"Values \s-1OID\s0 [\s-1OID\s0 ...]" 4
Item "Values OID [OID ...]" Configures the values to be queried from the \s-1SNMP\s0 host. The meaning slightly
changes with the
Table setting.
variables\|(5) from the \s-1SNMP\s0 distribution
describes the format of OIDs.
.Sp
If
Table is set to
true, each
\s-1OID\s0 must be the prefix of all the
values to query, e. g.
\*(C`IF-MIB::ifInOctets\*(C' for all the counters of
incoming traffic. This subtree is walked (using
\*(C`GETNEXT\*(C') until a value from
outside the subtree is returned.
.Sp
If
Table is set to
false, each
\s-1OID\s0 must be the \s-1OID\s0 of exactly one
value, e. g.
\*(C`IF-MIB::ifInOctets.3\*(C' for the third counter of incoming
traffic.
"Count true|false" 4
Item "Count true|false" Instead of dispatching one or multiple values per Table entry containing the
\fI\s-1OID\s0(s) given in the
Values option, just dispatch a single count giving the
number of entries that would have been dispatched. This is especially useful when
combined with the filtering options (see below) to count the number of entries in
a Table matching certain criteria.
.Sp
When
Table is set to
false, this option has no effect.
"Scale Value" 4
Item "Scale Value" The gauge-values returned by the SNMP-agent are multiplied by
Value. This
is useful when values are transferred as a fixed point real number. For example,
thermometers may transfer
243 but actually mean
24.3, so you can specify
a scale value of
0.1 to correct this. The default value is, of course,
\fB1.0.
.Sp
This value is not applied to counter-values.
"Shift Value" 4
Item "Shift Value" \fIValue is added to gauge-values returned by the SNMP-agent after they have
been multiplied by any
Scale value. If, for example, a thermometer returns
degrees Kelvin you could specify a shift of
273.15 here to store values in
degrees Celsius. The default value is, of course,
0.0.
.Sp
This value is not applied to counter-values.
"Ignore Value [, Value ...]" 4
Item "Ignore Value [, Value ...]" The ignore values allows one to ignore TypeInstances based on their name and
the patterns specified by the various values you've entered. The match is a
glob-type shell matching.
.Sp
When
Table is set to
false then this option has no effect.
"InvertMatch true|false(default)" 4
Item "InvertMatch true|false(default)" The invertmatch value should be use in combination of the Ignore option.
It changes the behaviour of the Ignore option, from a blacklist behaviour
when InvertMatch is set to false, to a whitelist when specified to true.
"FilterOID \s-1OID\s0" 4
Item "FilterOID OID" 0
"FilterValues Value [, Value ...]" 4
Item "FilterValues Value [, Value ...]" "FilterIgnoreSelected true|false(default)" 4
Item "FilterIgnoreSelected true|false(default)"
When Table is set to true, these options allow to configure filtering
based on \s-1MIB\s0 values.
.Sp
The FilterOID declares \s-1OID\s0 to fill table column with values.
The FilterValues declares values list to do match. Whether table row will be
collected or ignored depends on the FilterIgnoreSelected setting.
As with other plugins that use the daemon's ignorelist functionality, a string
that starts and ends with a slash is interpreted as a regular expression.
.Sp
If no selection is configured at all, all table rows are selected.
.Sp
When Table is set to false then these options has no effect.
.Sp
See Table and /\*(L"\s-1IGNORELISTS\*(R"\s0 for details.
"The Host block"
Subsection "The Host block" The
Host block defines which hosts to query, which \s-1SNMP\s0 community and
version to use and which of the defined
Data to query.
The argument passed to the Host block is used as the hostname in the data
stored by collectd.
"Address IP-Address|Hostname" 4
Item "Address IP-Address|Hostname" Set the address to connect to. Address may include transport specifier
and/
or
port number.
"Version 1|2|3" 4
Item "Version 1|2|3" Set the \s-1SNMP\s0 version to use. When giving
2 version
\*(C`2c\*(C' is actually used.
"Community Community" 4
Item "Community Community" Pass
Community to the host. (Ignored for SNMPv3).
"Username Username" 4
Item "Username Username" Sets the
Username to use for SNMPv3 security.
"SecurityLevel authPriv|authNoPriv|noAuthNoPriv" 4
Item "SecurityLevel authPriv|authNoPriv|noAuthNoPriv" Selects the security level for SNMPv3 security.
"Context Context" 4
Item "Context Context" Sets the
Context for SNMPv3 security.
"AuthProtocol \s-1MD5\s0|\s-1SHA\s0" 4
Item "AuthProtocol MD5|SHA" Selects the authentication protocol for SNMPv3 security.
"AuthPassphrase Passphrase" 4
Item "AuthPassphrase Passphrase" Sets the authentication passphrase for SNMPv3 security.
"PrivacyProtocol \s-1AES\s0|\s-1DES\s0" 4
Item "PrivacyProtocol AES|DES" Selects the privacy (encryption) protocol for SNMPv3 security.
"PrivacyPassphrase Passphrase" 4
Item "PrivacyPassphrase Passphrase" Sets the privacy (encryption) passphrase for SNMPv3 security.
"Collect Data [Data ...]" 4
Item "Collect Data [Data ...]" Defines which values to collect.
Data refers to one of the
Data block
above. Since the config file is read top-down you need to define the data
before using it here.
"Interval Seconds" 4
Item "Interval Seconds" Collect data from this host every
Seconds seconds. This option is meant for
devices with not much \s-1CPU\s0 power, e. g. network equipment such as
switches, embedded devices, rack monitoring systems and so on. Since the
\fBStep of generated \s-1RRD\s0 files depends on this setting it's wise to select a
reasonable value once and never change it.
"Timeout Seconds" 4
Item "Timeout Seconds" How long to wait for a response. The
\*(C`Net-SNMP\*(C' library default is 1 second.
"Retries Integer" 4
Item "Retries Integer" The number of times that a query should be retried after the Timeout expires.
The
\*(C`Net-SNMP\*(C' library default is 5.
"BulkSize Integer" 4
Item "BulkSize Integer" Configures the size of \s-1SNMP\s0 bulk transfers. The default is 0, which disables bulk transfers altogether.
"SEE ALSO"
Header "SEE ALSO" \fBcollectd\|(1),
\
fBcollectd.conf\|(5),
\fBsnmpget\|(1),
\fBsnmpgetnext\|(1),
\fBvariables\|(5),
\fBunix\|(7)
"AUTHORS"
Header "AUTHORS" Florian Forster <octo@collectd.org>
Michael Pilat <mike@mikepilat.com>