| Line | |
|---|
| 1 |
<module> |
|---|
| 2 |
<name>snmptrap</name> |
|---|
| 3 |
<description><para>The snmptrap module provides SNMP trap daemon support for reconnoiter. Reconnoiter comes with a <command>snmptrap</command>-based helper utility called <command>noittrap</command> aimed to assist with the complexities of forming valid SNMP traps to this module.</para></description> |
|---|
| 4 |
<loader>C</loader> |
|---|
| 5 |
<image>snmp.so</image> |
|---|
| 6 |
<moduleconfig> |
|---|
| 7 |
<parameter name="community" |
|---|
| 8 |
required="required" |
|---|
| 9 |
allowed=".+">The SNMP community string providing trap access.</parameter> |
|---|
| 10 |
<parameter name="snmptrapd_port" |
|---|
| 11 |
required="optional" |
|---|
| 12 |
defailt="162" |
|---|
| 13 |
allowed="\d+">The port on which traps are accepted.</parameter> |
|---|
| 14 |
</moduleconfig> |
|---|
| 15 |
<checkconfig> |
|---|
| 16 |
<parameter name="community" |
|---|
| 17 |
required="optional" |
|---|
| 18 |
allowed=".+">The SNMP community string providing trap access (overrides modules config).</parameter> |
|---|
| 19 |
</checkconfig> |
|---|
| 20 |
<examples> |
|---|
| 21 |
<example> |
|---|
| 22 |
<title>Simple passive checking.</title> |
|---|
| 23 |
<para>The following example configures a check prepared to accept traps from |
|---|
| 24 |
host 10.1.1.1. Traps must be performed with the community name 's3cr3t'. Note that |
|---|
| 25 |
because this check is passive, the timeout and period mean nothing to reconnoiter. |
|---|
| 26 |
Though these values may be used by an upstream provider for fault detection.</para> |
|---|
| 27 |
<programlisting><![CDATA[ |
|---|
| 28 |
<noit> |
|---|
| 29 |
<modules> |
|---|
| 30 |
<module image="snmp" name="snmptrap"> |
|---|
| 31 |
<config> |
|---|
| 32 |
<community>s3cr3t</community> |
|---|
| 33 |
</config> |
|---|
| 34 |
</module> |
|---|
| 35 |
</modules> |
|---|
| 36 |
<checks> |
|---|
| 37 |
<check uuid="1b4e28ba-2fa1-11d2-883f-e9b761bde3fb" module="snmptrap" name="magic" |
|---|
| 38 |
period="60000" timeout="30000"/> |
|---|
| 39 |
</checks> |
|---|
| 40 |
</noit> |
|---|
| 41 |
]]></programlisting> |
|---|
| 42 |
</example> |
|---|
| 43 |
</examples> |
|---|
| 44 |
</module> |
|---|