root/docs/config/modules/ping_icmp.xml

Revision 23dea7e00df87480acb58bb3398283c2bb227949, 3.8 kB (checked in by Theo Schlossnagle <jesus@omniti.com>, 3 years ago)

pull docs into master

  • Property mode set to 100644
Line 
1 <?xml version="1.0"?>
2 <section>
3   <title>ping_icmp</title>
4   <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>
5   <variablelist>
6     <varlistentry>
7       <term>loader</term>
8       <listitem>
9         <para>C</para>
10       </listitem>
11     </varlistentry>
12     <varlistentry>
13       <term>image</term>
14       <listitem>
15         <para>ping_icmp.so</para>
16       </listitem>
17     </varlistentry>
18   </variablelist>
19   <section>
20     <title>Module Configuration</title>
21   </section>
22   <section>
23     <title>Check Configuration</title>
24     <variablelist>
25       <varlistentry>
26         <term>interval</term>
27         <listitem>
28           <variablelist>
29             <varlistentry>
30               <term>required</term>
31               <listitem>
32                 <para>optional</para>
33               </listitem>
34             </varlistentry>
35             <varlistentry>
36               <term>default</term>
37               <listitem>
38                 <para>2000</para>
39               </listitem>
40             </varlistentry>
41             <varlistentry>
42               <term>allowed</term>
43               <listitem>
44                 <para>\d+</para>
45               </listitem>
46             </varlistentry>
47           </variablelist>
48           <para>The number of milliseconds between ICMP requests.</para>
49         </listitem>
50       </varlistentry>
51     </variablelist>
52     <variablelist>
53       <varlistentry>
54         <term>count</term>
55         <listitem>
56           <variablelist>
57             <varlistentry>
58               <term>required</term>
59               <listitem>
60                 <para>optional</para>
61               </listitem>
62             </varlistentry>
63             <varlistentry>
64               <term>default</term>
65               <listitem>
66                 <para>5</para>
67               </listitem>
68             </varlistentry>
69             <varlistentry>
70               <term>allowed</term>
71               <listitem>
72                 <para>\d+</para>
73               </listitem>
74             </varlistentry>
75           </variablelist>
76           <para>The number of ICMP requests to send during a single check.</para>
77         </listitem>
78       </varlistentry>
79     </variablelist>
80     <variablelist>
81       <varlistentry>
82         <term>avail_needed</term>
83         <listitem>
84           <variablelist>
85             <varlistentry>
86               <term>required</term>
87               <listitem>
88                 <para>optional</para>
89               </listitem>
90             </varlistentry>
91             <varlistentry>
92               <term>default</term>
93               <listitem>
94                 <para>100</para>
95               </listitem>
96             </varlistentry>
97             <varlistentry>
98               <term>allowed</term>
99               <listitem>
100                 <para>\d+</para>
101               </listitem>
102             </varlistentry>
103           </variablelist>
104           <para>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.</para>
105         </listitem>
106       </varlistentry>
107     </variablelist>
108   </section>
109   <example>
110     <title>Ping checks against a host</title>
111     <para>Ping 4.2.2.1 once a second for ten seconds recurring every 60 seconds.</para>
112     <programlisting>
113       &lt;noit&gt;
114         &lt;modules&gt;
115           &lt;module image="ping_icmp" name="ping_icmp"/&gt;
116         &lt;/modules&gt;
117         &lt;checks&gt;
118           &lt;ping module="ping_icmp" period="60000"&gt;
119             &lt;config&gt;
120               &lt;count&gt;10&lt;/count&gt;
121               &lt;interval&gt;1000&lt;/interval&gt;
122             &lt;/config&gt;
123             &lt;check uuid="5b9fab60-77d4-11dd-99a4-97df794be4c8" target="4.2.2.1"/&gt;
124           &lt;/ping&gt;
125         &lt;/checks&gt;
126       &lt;/noit&gt;
127     </programlisting>
128   </example>
129 </section>
Note: See TracBrowser for help on using the browser.