X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=src%2Fcollectd-snmp.pod;h=65a9b7c3d320098e40a3b491865e0067d8d53197;hb=871b643dc18d7ffe0ba8334dc5fb222741433774;hp=0f7e3a4ee80aef38d216f01efa97af99c6b1767d;hpb=aff2b94c1747e16e1a550f09a0b16f6c3cbf63e4;p=collectd.git diff --git a/src/collectd-snmp.pod b/src/collectd-snmp.pod index 0f7e3a4e..65a9b7c3 100644 --- a/src/collectd-snmp.pod +++ b/src/collectd-snmp.pod @@ -1,3 +1,5 @@ +=encoding UTF-8 + =head1 NAME collectd-snmp - Documentation of collectd's C @@ -11,12 +13,14 @@ collectd-snmp - Documentation of collectd's C Type "voltage" Table false Instance "input_line1" + Scale 0.1 Values "SNMPv2-SMI::enterprises.6050.5.4.1.1.2.1" Type "users" Table false Instance "" + Shift -1 Values "HOST-RESOURCES-MIB::hrSystemNumUsers.0" @@ -31,7 +35,7 @@ collectd-snmp - Documentation of collectd's C Version 1 Community "community_string" Collect "std_traffic" - Inverval 120 + Interval 120 Address "192.168.0.42" @@ -39,6 +43,17 @@ collectd-snmp - Documentation of collectd's C Community "another_string" Collect "std_traffic" "hr_users" + + Address "192.168.0.7" + Version 3 + SecurityLevel "authPriv" + Username "cosmo" + AuthProtocol "SHA" + AuthPassphrase "setec_astronomy" + PrivacyProtocol "AES" + PrivacyPassphrase "too_many_secrets" + Collect "std_traffic" + Address "192.168.0.3" Version 1 @@ -65,6 +80,9 @@ and ten threads are used. 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. +Since the C library is used you can use all the environment variables +that are interpreted by that package. See L for more details. + There are two types of blocks that can be contained in the CPluginEsnmpE> block: B and B: @@ -80,7 +98,7 @@ queried. The following options can be set: 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. +defined. See L for a description of the format of this file. =item B I @@ -125,14 +143,31 @@ Sets the type-instance of the values that are dispatched. The meaning of this setting depends on whether 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 +that will return a list of values. Those values are then used as the actual type-instance. An example would be the C subtree. L from the SNMP distribution describes the format of OIDs. +If B
is set to I and B is omitted, then "SUBID" will be +used as the instance. + 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 + +If B
is set to I, you may feel the need to add something to the +instance of the files. If set, I is prepended to the instance as +determined by querying the agent. When B
is set to I this option +has no effect. + +The C is an example where you need this setting: It has voltages of +the inlets, outlets and the battery of an UPS. However, it doesn't provide a +descriptive column for these voltages. In this case having 1, 2,E... as +instances is not enough, because the inlet voltages and outlet voltages may +both have the subids 1, 2,E... You can use this setting to distinguish +between the different voltages. + =item B I [I ...] Configures the values to be queried from the SNMP host. The meaning slightly @@ -148,6 +183,37 @@ 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. +=item B I + +The gauge-values returned by the SNMP-agent are multiplied by I. This +is useful when values are transferred as a fixed point real number. For example, +thermometers may transfer B<243> but actually mean B<24.3>, so you can specify +a scale value of B<0.1> to correct this. The default value is, of course, +B<1.0>. + +This value is not applied to counter-values. + +=item B I + +I is added to gauge-values returned by the SNMP-agent after they have +been multiplied by any B value. If, for example, a thermometer returns +degrees Kelvin you could specify a shift of B<273.15> here to store values in +degrees Celsius. The default value is, of course, B<0.0>. + +This value is not applied to counter-values. + +=item B I [, I ...] + +The ignore values allows to ignore Instances based on their name and the patterns +specified by the various values you've entered. The match is a glob-type shell +matching. + +=item B I + +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. + =back =head2 The Host block @@ -164,14 +230,41 @@ stored by collectd. Set the address to connect to. -=item B B<1>|B<2> +=item B B<1>|B<2>|B<3> -Set the SNMP version to use. When giving B<2> version 2c is actually used. -Version 3 is not supported by this plugin. +Set the SNMP version to use. When giving B<2> version C<2c> is actually used. =item B I -Pass I to the host. +Pass I to the host. (Ignored for SNMPv3). + +=item B I + +Sets the I to use for SNMPv3 security. + +=item B I|I|I + +Selects the security level for SNMPv3 security. + +=item B I + +Sets the I for SNMPv3 security. + +=item B I|I + +Selects the authentication protocol for SNMPv3 security. + +=item B I + +Sets the authentication passphrase for SNMPv3 security. + +=item B I|I + +Selects the privacy (encryption) protocol for SNMPv3 security. + +=item B I + +Sets the privacy (encryption) passphrase for SNMPv3 security. =item B I [I ...] @@ -181,16 +274,11 @@ before using it here. =item B I -Collect data from this host every I seconds. This value needs to be a -multiple of the global B setting and, if it is not, will be rounded -B to one and a warning is logged in this case. So if your global -B is set to I<10> and you configure I<25> here, it's rounded down to -I<20>. By default the global B setting will be used. - -This option is meant for devices with not much CPU power, e.Eg. network -equipment such as switches, embedded devices, rack monitoring systems and so -on. Since the B of generated RRD files depends on this setting it's -wise to select a reasonable value once and never change it. +Collect data from this host every I seconds. This option is meant for +devices with not much CPU power, e.Eg. network equipment such as +switches, embedded devices, rack monitoring systems and so on. Since the +B of generated RRD files depends on this setting it's wise to select a +reasonable value once and never change it. =back @@ -203,8 +291,9 @@ L, L, L -=head1 AUTHOR +=head1 AUTHORS -Florian Forster Eocto@verplant.orgE +Florian Forster Eocto@collectd.orgE +Michael Pilat Emike@mikepilat.comE =cut