snmp plugin: Allow to set plugin value in reported metrics

[collectd.git] / src / collectd-snmp.pod

diff --git a/src/collectd-snmp.pod b/src/collectd-snmp.pod
index c246f1d..f83c60b 100644 (file)
--- a/src/collectd-snmp.pod
+++ b/src/collectd-snmp.pod
@@ -36,6 +36,8 @@ collectd-snmp - Documentation of collectd's C<snmp plugin>
       Community "community_string"
       Collect "std_traffic"
       Interval 120
       Community "community_string"
       Collect "std_traffic"
       Interval 120

+      Timeout 10
+      Retries 1

     </Host>
     <Host "some.server.mydomain.org">
       Address "192.168.0.42"
     </Host>
     <Host "some.server.mydomain.org">
       Address "192.168.0.42"


@@ -44,7 +46,7 @@ collectd-snmp - Documentation of collectd's C<snmp plugin>
       Collect "std_traffic" "hr_users"
     </Host>
     <Host "secure.router.mydomain.org">
       Collect "std_traffic" "hr_users"
     </Host>
     <Host "secure.router.mydomain.org">

-      Address "192.168.0.7"
+      Address "192.168.0.7:165"

       Version 3
       SecurityLevel "authPriv"
       Username "cosmo"
       Version 3
       SecurityLevel "authPriv"
       Username "cosmo"


@@ -55,11 +57,13 @@ collectd-snmp - Documentation of collectd's C<snmp plugin>
       Collect "std_traffic"
     </Host>
     <Host "some.ups.mydomain.org">
       Collect "std_traffic"
     </Host>
     <Host "some.ups.mydomain.org">

-      Address "192.168.0.3"
+      Address "tcp:192.168.0.3"

       Version 1
       Community "more_communities"
       Collect "powerplus_voltge_input"
       Interval 300
       Version 1
       Community "more_communities"
       Collect "powerplus_voltge_input"
       Interval 300

+      Timeout 5
+      Retries 5

     </Host>
   </Plugin>
 
     </Host>
   </Plugin>
 


@@ -78,7 +82,7 @@ and ten threads are used.
 =head1 CONFIGURATION
 
 Since the aim of the C<snmp plugin> is to provide a generic interface to SNMP,
 =head1 CONFIGURATION
 
 Since the aim of the C<snmp plugin> is to provide a generic interface to SNMP,

-it's configuration is not trivial and may take some time.
+its configuration is not trivial and may take some time.

 
 Since the C<Net-SNMP> library is used you can use all the environment variables
 that are interpreted by that package. See L<snmpcmd(1)> for more details.
 
 Since the C<Net-SNMP> library is used you can use all the environment variables
 that are interpreted by that package. See L<snmpcmd(1)> for more details.


@@ -137,6 +141,11 @@ Since the semantic of B<Instance> and B<Values> depends on this setting you
 need to set it before setting them. Doing vice verse will result in undefined
 behavior.
 
 need to set it before setting them. Doing vice verse will result in undefined
 behavior.
 

+=item B<Plugin> I<Plugin>
+
+Use I<Plugin> as the plugin name of the values that are dispatched.
+Defaults to C<snmp>.
+

 =item B<Instance> I<Instance>
 
 Sets the type-instance of the values that are dispatched. The meaning of this
 =item B<Instance> I<Instance>
 
 Sets the type-instance of the values that are dispatched. The meaning of this


@@ -228,7 +237,8 @@ stored by collectd.
 
 =item B<Address> I<IP-Address>|I<Hostname>
 
 
 =item B<Address> I<IP-Address>|I<Hostname>
 

-Set the address to connect to.
+Set the address to connect to. Address may include transport specifier and/or
+port number.

 
 =item B<Version> B<1>|B<2>|B<3>
 
 
 =item B<Version> B<1>|B<2>|B<3>
 


@@ -280,6 +290,15 @@ switches, embedded devices, rack monitoring systems and so on. Since the
 B<Step> of generated RRD files depends on this setting it's wise to select a
 reasonable value once and never change it.
 
 B<Step> of generated RRD files depends on this setting it's wise to select a
 reasonable value once and never change it.
 

+=item B<Timeout> I<Seconds>
+
+How long to wait for a response. The C<Net-SNMP> library default is 1 second.
+
+=item B<Retries> I<Integer>
+
+The number of times that a query should be retried after the Timeout expires.
+The C<Net-SNMP> library default is 5.
+

 =back
 
 =head1 SEE ALSO
 =back
 
 =head1 SEE ALSO