root/src/modules/ping_icmp.xml

Revision fe3d821d356a8a6397a0ef63e64ccceee5d2430d, 1.7 kB (checked in by Theo Schlossnagle <jesus@omniti.com>, 5 years ago)

first whack at custom threshold. refs #159

  • Property mode set to 100644
Line 
1 <module>
2   <name>ping_icmp</name>
3   <description><para>The ping_icmp module provide ICMP checks against targets.  It sends a series of ICMP requests and waits for their responses tallying their turn-around time.</para>
4   </description>
5   <loader>C</loader>
6   <image>ping_icmp.so</image>
7   <moduleconfig />
8   <checkconfig>
9     <parameter name="interval"
10                required="optional"
11                default="2000"
12                allowed="\d+">The number of milliseconds between ICMP requests.</parameter>
13     <parameter name="count"
14                required="optional"
15                default="5"
16                allowed="\d+">The number of ICMP requests to send during a single check.</parameter>
17     <parameter name="avail_needed"
18                required="optional"
19                default="100"
20                allowed="\d+">The percentage of ICMP available required for the check to be considered "good."  By default, 100% of the ICMP requests must have responses for a good state.</parameter>
21   </checkconfig>
22   <examples>
23     <example>
24       <title>Ping checks against a host</title>
25       <para>Ping 4.2.2.1 once a second for ten seconds recurring every 60 seconds.</para>
26       <programlisting><![CDATA[
27       <noit>
28         <modules>
29           <module image="ping_icmp" name="ping_icmp"/>
30         </modules>
31         <checks>
32           <ping module="ping_icmp" period="60000">
33             <config>
34               <count>10</count>
35               <interval>1000</interval>
36             </config>
37             <check uuid="5b9fab60-77d4-11dd-99a4-97df794be4c8" target="4.2.2.1"/>
38           </ping>
39         </checks>
40       </noit>
41     ]]></programlisting>
42     </example>
43   </examples>
44 </module>
Note: See TracBrowser for help on using the browser.