root/docs/config/modules/noit.module.ntp.xml

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

fix ntp default port in docs and do sweeping docs update

  • Property mode set to 100644
Line 
1 <?xml version="1.0"?>
2 <section>
3   <title>ntp</title>
4   <para>Determine clock skew from an NTP source.</para>
5   <variablelist>
6     <varlistentry>
7       <term>loader</term>
8       <listitem>
9         <para>lua</para>
10       </listitem>
11     </varlistentry>
12     <varlistentry>
13       <term>object</term>
14       <listitem>
15         <para>noit.module.ntp</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>port</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>123</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 port to which we will attempt to speak NTP.</para>
49         </listitem>
50       </varlistentry>
51     </variablelist>
52     <variablelist>
53       <varlistentry>
54         <term>control</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>^false$</para>
67               </listitem>
68             </varlistentry>
69             <varlistentry>
70               <term>allowed</term>
71               <listitem>
72                 <para>^(?:true|on|false|off)$</para>
73               </listitem>
74             </varlistentry>
75           </variablelist>
76           <para>Use the NTP control protocol to learn about the other end.  If thise ois not true/on, then this check will determine the NTP telemetry of the target relative to the agent's local time.  If it is true/on, then the agent will request the NTP telemetry of the target regarding it's preferred peer.</para>
77         </listitem>
78       </varlistentry>
79     </variablelist>
80   </section>
81   <example>
82     <title>Monitor an NTP service</title>
83     <para>The following example monitors an NTP services on 10.1.2.3.</para>
84     <programlisting>
85       &lt;noit&gt;
86         &lt;modules&gt;
87           &lt;loader image="lua" name="lua"&gt;
88             &lt;config&gt;&lt;directory&gt;/opt/reconnoiter/libexec/modules-lua/?.lua&lt;/directory&gt;&lt;/config&gt;
89           &lt;/loader&gt;
90           &lt;module loader="lua" name="ntp" object="noit.module.ntp"/&gt;
91         &lt;/modules&gt;
92         &lt;checks&gt;
93           &lt;check uuid="4ee1a1e2-1e60-11df-8e99-bf796ca462ef" module="ntp" target="10.1.2.3" period="60000" timeout="5000"/&gt;
94         &lt;/checks&gt;
95       &lt;/noit&gt;
96       </programlisting>
97   </example>
98 </section>
Note: See TracBrowser for help on using the browser.