root/docs/config/modules/ping_icmp.xml

Revision 412c3dbfb208525e7fa8d2885a956e8295721507, 3.9 kB (checked in by Theo Schlossnagle <jesus@omniti.com>, 2 months ago)

Actual native docbook.

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