root/src/modules/snmp.xml

Revision 27a24a1299993c406f04ffa643b95fa8b14705bc, 4.4 kB (checked in by Theo Schlossnagle <jesus@omniti.com>, 6 years ago)

integrate the framework for docs... snmp docs

  • Property mode set to 100644
Line 
1 <module>
2   <name>snmp</name>
3   <description>The snmp module provides SNMP polling support for reconnoiter.</description>
4   <loader>C</loader>
5   <image>snmp.so</image>
6   <moduleconfig />
7   <checkconfig>
8     <parameter name="community"
9                required="optional"
10                default="public"
11                allowed=".+">The SNMP community string providing read access.</parameter>
12     <parameter name="oid_.+"
13                required="optional"
14                allowed=".+">Defines a metric to query.  Key oid_foo will establish a metric called foo.  The value of the parameter should be an OID either in decimal notation or MIB name.</parameter>
15   </checkconfig>
16   <examples>
17     <example>
18       <title>Simple snmp polling of two switchports</title>
19       <para>The following example configures SNMP checks against switchport 1 and 2
20       on the switch with the IP address 10.80.116.3.</para>
21       <programlisting><![CDATA[
22       <noit>
23         <modules>
24           <module image="snmp" name="snmp"/>
25         </modules>
26         <checks>
27           <switch target="10.80.116.3">
28             <config>
29               <community>SeKr3t</community>
30               <oid_description>IF-MIB::ifName.%[name]</oid_description>
31               <oid_alias>IF-MIB::ifAlias.%[name]</oid_alias>
32               <oid_speed>IF-MIB::ifSpeed.%[name]</oid_speed>
33               <oid_adminstatus>IF-MIB::ifAdminStatus.%[name]</oid_adminstatus>
34               <oid_operstatus>IF-MIB::ifOperStatus.%[name]</oid_operstatus>
35               <oid_inoctets>IF-MIB::ifHCInOctets.%[name]</oid_inoctets>
36               <oid_outoctets>IF-MIB::ifHCOutOctets.%[name]</oid_outoctets>
37               <oid_inerrors>IF-MIB::ifInErrors.%[name]</oid_inerrors>
38               <oid_outerrors>IF-MIB::ifOutErrors.%[name]</oid_outerrors>
39               <oid_indiscards>IF-MIB::ifInDiscards.%[name]</oid_indiscards>
40               <oid_outdiscards>IF-MIB::ifOutDiscards.%[name]</oid_outdiscards>
41               <oid_inucastpkts>IF-MIB::ifHCInUcastPkts.%[name]</oid_inucastpkts>
42               <oid_outucastpkts>IF-MIB::ifHCOutUcastPkts.%[name]</oid_outucastpkts>
43               <oid_inbcastpkts>IF-MIB::ifHCInBroadcastPkts.%[name]</oid_inbcastpkts>
44               <oid_outbcastpkts>IF-MIB::ifHCOutBroadcastPkts.%[name]</oid_outbcastpkts>
45             </config>
46             <check uuid="1b4e28ba-2fa1-11d2-883f-e9b761bde3fb" name="1"/>
47             <check uuid="4deb0724-ccee-4360-83bc-255e7b9d989d" name="2"/>
48           </switch>
49         </checks>
50       </noit>
51     ]]></programlisting>
52     </example>
53     <example>
54       <title>Example using config inheritance to show reuse</title>
55       <para>Accomplising the same goal, but by using reuse:</para>
56
57       <programlisting><![CDATA[
58       <noit>
59         <modules>
60           <module image="snmp" name="snmp"/>
61         </modules>
62         <checks>
63           <switch target="10.80.116.3" module="snmp">
64             <config inherit="SwitchPortX"/>
65               <community>SeKr3t</community>
66             </config>
67             <check uuid="1b4e28ba-2fa1-11d2-883f-e9b761bde3fb" name="1"/>
68             <check uuid="4deb0724-ccee-4360-83bc-255e7b9d989d" name="2"/>
69           </switch>
70         </checks>
71         <config_templates>
72           <config id="SwitchPortX">
73             <oid_description>IF-MIB::ifName.%[name]</oid_description>
74             <oid_alias>IF-MIB::ifAlias.%[name]</oid_alias>
75             <oid_speed>IF-MIB::ifSpeed.%[name]</oid_speed>
76             <oid_adminstatus>IF-MIB::ifAdminStatus.%[name]</oid_adminstatus>
77             <oid_operstatus>IF-MIB::ifOperStatus.%[name]</oid_operstatus>
78             <oid_inoctets>IF-MIB::ifHCInOctets.%[name]</oid_inoctets>
79             <oid_outoctets>IF-MIB::ifHCOutOctets.%[name]</oid_outoctets>
80             <oid_inerrors>IF-MIB::ifInErrors.%[name]</oid_inerrors>
81             <oid_outerrors>IF-MIB::ifOutErrors.%[name]</oid_outerrors>
82             <oid_indiscards>IF-MIB::ifInDiscards.%[name]</oid_indiscards>
83             <oid_outdiscards>IF-MIB::ifOutDiscards.%[name]</oid_outdiscards>
84             <oid_inucastpkts>IF-MIB::ifHCInUcastPkts.%[name]</oid_inucastpkts>
85             <oid_outucastpkts>IF-MIB::ifHCOutUcastPkts.%[name]</oid_outucastpkts>
86             <oid_inbcastpkts>IF-MIB::ifHCInBroadcastPkts.%[name]</oid_inbcastpkts>
87             <oid_outbcastpkts>IF-MIB::ifHCOutBroadcastPkts.%[name]</oid_outbcastpkts>
88           </config>
89         </config_templates>
90       </noit>
91     ]]></programlisting>
92     </example>
93   </examples>
94 </module>
Note: See TracBrowser for help on using the browser.