Skip to content

Plugin SNMP Agent

Florian Forster edited this page Nov 26, 2023 · 1 revision
Clone this wiki locally

Name:

SNMP Agent plugin

Type:

write

Callbacks:

init, config, write, missing, shutdown

Status:

supported

FirstVersion:

5.8

Copyright:

2017 Intel Corporation, Roman Korynkevych
Serhiy Pshyk

License:

MIT License

Manpage:

collectd.conf(5)

See also:

List of Plugins

The SNMP Agent plugin is an AgentX subagent that receives and handles queries from SNMP master agent and returns the data collected by read plugins. The SNMP Agent plugin handles requests only for OIDs specified in configuration file. To handle SNMP queries the plugin gets data from collectd and translates requested values from collectd's internal format to SNMP format.

This plugin is a generic plugin, i.e. it cannot work without configuration, because there is no reasonable default behavior. Please read the Plugin snmp_agent section of the collectd.conf(5) manual page for an in-depth description of the plugin's configuration.

Synopsis

 <nowiki><Plugin snmp_agent>
   <Data "memAvailReal">
     Plugin "memory"
     Type "memory"
     TypeInstance "free"
     OIDs "1.3.6.1.4.1.2021.4.6.0"
   </Data>
   <Table "ifTable">
     IndexOID "IF-MIB::ifIndex"
     SizeOID "IF-MIB::ifNumber"
     <Data "ifDescr">
       Instance true
       Plugin "interface"
       OIDs "IF-MIB::ifDescr"
     </Data>
     <Data "ifOctets">
       Plugin "interface"
       Type "if_octets"
       TypeInstance ""
       OIDs "IF-MIB::ifInOctets" "IF-MIB::ifOutOctets"
     </Data>
   </Table>
 </Plugin></nowiki>

Parameters

For more information on the configuration parameters, see collectd.conf(5).

Example graph

None yet. Add one now!

Dependencies

Caveats

History

  • 5.8: This new plugin implements an SNMP AgentX subagent that receives and handles queries from SNMP master agent and returns configured metrics.
  • 5.9: Multiple key indexes to snmp table and other new features have been added, refactoring, coverity scan issues have been fixed.

See also