| 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 |
</checkconfig> |
|---|
| 18 |
<examples> |
|---|
| 19 |
<example> |
|---|
| 20 |
<title>Ping checks against a host</title> |
|---|
| 21 |
<para>Ping 4.2.2.1 once a second for ten seconds recurring every 60 seconds.</para> |
|---|
| 22 |
<programlisting><![CDATA[ |
|---|
| 23 |
<noit> |
|---|
| 24 |
<modules> |
|---|
| 25 |
<module image="ping_icmp" name="ping_icmp"/> |
|---|
| 26 |
</modules> |
|---|
| 27 |
<checks> |
|---|
| 28 |
<ping module="ping_icmp" period="60000"> |
|---|
| 29 |
<config> |
|---|
| 30 |
<count>10</count> |
|---|
| 31 |
<interval>1000</interval> |
|---|
| 32 |
</config> |
|---|
| 33 |
<check uuid="5b9fab60-77d4-11dd-99a4-97df794be4c8" target="4.2.2.1"/> |
|---|
| 34 |
</ping> |
|---|
| 35 |
</checks> |
|---|
| 36 |
</noit> |
|---|
| 37 |
]]></programlisting> |
|---|
| 38 |
</example> |
|---|
| 39 |
</examples> |
|---|
| 40 |
</module> |
|---|
