root/docs/config/modules/check_test.xml

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

docbook parts

  • Property mode set to 100644
Line 
1 <?xml version="1.0"?>
2 <section>
3   <title>check_test</title>
4   <para>
5             This module exposes an API endpoint to
6             allow users to run a check once in transient mode to
7             return the results inline back to the client.
8         </para>
9   <para>
10             The check runs once however it behaves almost exactly like a /check/set</para>
11   <variablelist>
12     <varlistentry>
13       <term>loader</term>
14       <listitem>
15         <para>C</para>
16       </listitem>
17     </varlistentry>
18     <varlistentry>
19       <term>image</term>
20       <listitem>
21         <para>check_test.so</para>
22       </listitem>
23     </varlistentry>
24   </variablelist>
25   <section>
26     <title>Module Configuration</title>
27   </section>
28   <section>
29     <title>Check Configuration</title>
30   </section>
31   <example>
32     <title>Loading the check_test module.</title>
33     <para>This example loads the check_test module.</para>
34     <programlisting>
35       &lt;noit&gt;
36         &lt;modules&gt;
37           &lt;generic image="check_test" name="check_test" /&gt;
38         &lt;/modules&gt;
39       &lt;/noit&gt;
40     </programlisting>
41   </example>
42 </section>
Note: See TracBrowser for help on using the browser.