From 4a5e7a39a7a3ecbc009c85215608ecec970cedf1 Mon Sep 17 00:00:00 2001 From: Florian Forster Date: Fri, 1 Jun 2007 18:03:45 +0200 Subject: [PATCH] collectd-snmp(5): Added a manpage for the SNMP plugin. --- src/Makefile.am | 2 +- src/collectd-snmp.pod | 176 ++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 177 insertions(+), 1 deletion(-) create mode 100644 src/collectd-snmp.pod diff --git a/src/Makefile.am b/src/Makefile.am index a1f2afa5..1007dbc5 100644 --- a/src/Makefile.am +++ b/src/Makefile.am @@ -559,7 +559,7 @@ endif dist_man_MANS = collectd.1 collectd-nagios.1 collectd.conf.5 \ collectd-email.5 collectd-exec.5 collectd-perl.5 \ - collectd-unixsock.5 + collectd-snmp.5 collectd-unixsock.5 #collectd_1_SOURCES = collectd.pod diff --git a/src/collectd-snmp.pod b/src/collectd-snmp.pod new file mode 100644 index 00000000..af416751 --- /dev/null +++ b/src/collectd-snmp.pod @@ -0,0 +1,176 @@ +=head1 NAME + +collectd-snmp - Documentation of collectd's C + +=head1 SYNOPSIS + + LoadPlugin snmp + # ... + + + Type "voltage" + Table false + Instance "input_line1" + Values "SNMPv2-SMI::enterprises.6050.5.4.1.1.2.1" + + + Type "users" + Table false + Instance "" + Values "HOST-RESOURCES-MIB::hrSystemNumUsers.0" + + + Type "if_octets" + Table true + Instance "IF-MIB::ifDescr" + Values "IF-MIB::ifInOctets" "IF-MIB::ifOutOctets" + + + + Address "192.168.0.2" + Version 1 + Community "community_string" + Collect "std_traffic" + + + Address "192.168.0.42" + Version 2 + Community "another_string" + Collect "std_traffic" "hr_users" + + + Address "192.168.0.3" + Version 1 + Community "more_communities" + Collect "powerplus_voltge_input" + + + +=head1 DESCRIPTION + +The C queries other hosts using SNMP, 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. + +=head1 CONFIGURATION + +Since the aim of the C is to provide a generic interface to SNMP, +it's configuration is not trivial and may take some time. + +There are two types of blocks that can be contained in the +CPluginEsnmpE> block: B and B: + +=head2 The B block + +The B block defines a list of values or a table of values that are to be +queried. The following options can be set: + +=over 4 + +=item B I + +collectd's type that is to be used, e.Eg. "if_octets" for interface +traffic or "users" for a user count. The types are read from the B +(see L), so you may want to check for which types are +defined. + +=item B I + +Define if this is a single list of values or a table of values. The difference +is that when querying a list of values from SNMP that data is going to be +dispatched as one value-list to the daemon (i.Ee. one RRD file will be +created). If the correcponding data-set needs more than one value (has more +than one data-source) you will still need to configure more than one B +(see below). + +If B
is set to I then the plugin will search the entire subtree +and dispatch all values it can find. This is handy for the typical SNMP +tables, such as the interface table (C). + +Since the semantic of B and B depends on this setting you +need to set it before setting them. Doing vice verse will result in undefined +behavior. + +=item B I + +Sets the type-instance of the values that are dispatched. The meaning of this +setting depends on wether B
is set to I or I: + +If B
is set to I, I is interpreted as an SNMP-prefix +that will return a list of strings. Those strings are then used as the actual +type-instance. An example would be the C subtree. +L describes the format of OIDs. + +If B
is set to I the actual string configured for I is +copied into the value-list. In this case I may be empty, i.Ee. +"". + +=item B I [I ...] + +Configures the values to be queried from the SNMP host. The meaning slightly +changes with the B
setting. L describes the format of +OIDs. + +If B
is set to I, each I must be the prefix of all the +values to query, e.Eg. C for all the counters of +incoming traffic. This subtree is walked (using C) until a value from +outside the subtree is returned. + +If B
is set to I, each I must be the OID of exactly one +value, e.Eg. C for the third counter of incoming +traffic. + +=back + +=head2 The Head block + +The B block defines which hosts to query, which SNMP community and +version to use and which of the defined B to query. + +The argument passed to the B block is used as the hostname in the data +stored by collectd. + +=over 4 + +=item B
I|I + +Set the address to connect to. + +=item B B<1>|B<2> + +Set the SNMP version to use. When giving B<2> version 2c is actually used. +Version 3 is not supported by this plugin. + +=item B I + +Pass I to the host. + +=item B I [I ...] + +Defines which values to collect. I refers to one of the B block +above. Since the config file is read top-down you need to define the data +before using it here. + +=back + +=head1 BUGS + +All configured hosts are queried sequencially, so timeouts may cause gaps in +graphs. + +=head1 SEE ALSO + +L, +L, +L, +L, +L, +L + +=head1 AUTHOR + +Florian Forster Eocto@verplant.orgE + +=cut -- 2.30.2