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

Revision a64139dcd7cce8a609a80ee6827795c4ee240da5, 11.7 kB (checked in by Theo Schlossnagle <jesus@omniti.com>, 2 years ago)

update docs from code

  • Property mode set to 100644
Line 
1 <?xml version="1.0"?>
2 <section>
3   <title>smtp</title>
4   <para>Send an email via an SMTP server.</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.smtp</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>25</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>Specifies the TCP port to connect to.</para>
49         </listitem>
50       </varlistentry>
51     </variablelist>
52     <variablelist>
53       <varlistentry>
54         <term>ehlo</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>noit.local</para>
67               </listitem>
68             </varlistentry>
69             <varlistentry>
70               <term>allowed</term>
71               <listitem>
72                 <para>.+</para>
73               </listitem>
74             </varlistentry>
75           </variablelist>
76           <para>Specifies the EHLO parameter.</para>
77         </listitem>
78       </varlistentry>
79     </variablelist>
80     <variablelist>
81       <varlistentry>
82         <term>from</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/>
95               </listitem>
96             </varlistentry>
97             <varlistentry>
98               <term>allowed</term>
99               <listitem>
100                 <para>.+</para>
101               </listitem>
102             </varlistentry>
103           </variablelist>
104           <para>Specifies the envelope sender.</para>
105         </listitem>
106       </varlistentry>
107     </variablelist>
108     <variablelist>
109       <varlistentry>
110         <term>to</term>
111         <listitem>
112           <variablelist>
113             <varlistentry>
114               <term>required</term>
115               <listitem>
116                 <para>required</para>
117               </listitem>
118             </varlistentry>
119             <varlistentry>
120               <term>allowed</term>
121               <listitem>
122                 <para>.+</para>
123               </listitem>
124             </varlistentry>
125           </variablelist>
126           <para>Specifies the envelope recipient.</para>
127         </listitem>
128       </varlistentry>
129     </variablelist>
130     <variablelist>
131       <varlistentry>
132         <term>payload</term>
133         <listitem>
134           <variablelist>
135             <varlistentry>
136               <term>required</term>
137               <listitem>
138                 <para>optional</para>
139               </listitem>
140             </varlistentry>
141             <varlistentry>
142               <term>default</term>
143               <listitem>
144                 <para>Subject: Testing</para>
145               </listitem>
146             </varlistentry>
147             <varlistentry>
148               <term>allowed</term>
149               <listitem>
150                 <para>.+</para>
151               </listitem>
152             </varlistentry>
153           </variablelist>
154           <para>Specifies the payload sent (on the wire). CR LF DOT CR LF is appended automatically.</para>
155         </listitem>
156       </varlistentry>
157     </variablelist>
158     <variablelist>
159       <varlistentry>
160         <term>starttls</term>
161         <listitem>
162           <variablelist>
163             <varlistentry>
164               <term>required</term>
165               <listitem>
166                 <para>optional</para>
167               </listitem>
168             </varlistentry>
169             <varlistentry>
170               <term>default</term>
171               <listitem>
172                 <para>false</para>
173               </listitem>
174             </varlistentry>
175             <varlistentry>
176               <term>allowed</term>
177               <listitem>
178                 <para>(?:true|false)</para>
179               </listitem>
180             </varlistentry>
181           </variablelist>
182           <para>Specified if the client should attempt a STARTTLS upgrade</para>
183         </listitem>
184       </varlistentry>
185     </variablelist>
186     <variablelist>
187       <varlistentry>
188         <term>ca_chain</term>
189         <listitem>
190           <variablelist>
191             <varlistentry>
192               <term>required</term>
193               <listitem>
194                 <para>optional</para>
195               </listitem>
196             </varlistentry>
197             <varlistentry>
198               <term>allowed</term>
199               <listitem>
200                 <para>.+</para>
201               </listitem>
202             </varlistentry>
203           </variablelist>
204           <para>A path to a file containing all the certificate authorities that should be loaded to validate the remote certificate (for SSL checks).</para>
205         </listitem>
206       </varlistentry>
207     </variablelist>
208     <variablelist>
209       <varlistentry>
210         <term>certificate_file</term>
211         <listitem>
212           <variablelist>
213             <varlistentry>
214               <term>required</term>
215               <listitem>
216                 <para>optional</para>
217               </listitem>
218             </varlistentry>
219             <varlistentry>
220               <term>allowed</term>
221               <listitem>
222                 <para>.+</para>
223               </listitem>
224             </varlistentry>
225           </variablelist>
226           <para>A path to a file containing the client certificate that will be presented to the remote server (for SSL checks).</para>
227         </listitem>
228       </varlistentry>
229     </variablelist>
230     <variablelist>
231       <varlistentry>
232         <term>key_file</term>
233         <listitem>
234           <variablelist>
235             <varlistentry>
236               <term>required</term>
237               <listitem>
238                 <para>optional</para>
239               </listitem>
240             </varlistentry>
241             <varlistentry>
242               <term>allowed</term>
243               <listitem>
244                 <para>.+</para>
245               </listitem>
246             </varlistentry>
247           </variablelist>
248           <para>A path to a file containing key to be used in conjunction with the cilent certificate (for SSL checks).</para>
249         </listitem>
250       </varlistentry>
251     </variablelist>
252     <variablelist>
253       <varlistentry>
254         <term>ciphers</term>
255         <listitem>
256           <variablelist>
257             <varlistentry>
258               <term>required</term>
259               <listitem>
260                 <para>optional</para>
261               </listitem>
262             </varlistentry>
263             <varlistentry>
264               <term>allowed</term>
265               <listitem>
266                 <para>.+</para>
267               </listitem>
268             </varlistentry>
269           </variablelist>
270           <para>A list of ciphers to be used in the SSL protocol (for SSL checks).</para>
271         </listitem>
272       </varlistentry>
273     </variablelist>
274     <variablelist>
275       <varlistentry>
276         <term>sasl_authentication</term>
277         <listitem>
278           <variablelist>
279             <varlistentry>
280               <term>required</term>
281               <listitem>
282                 <para>optional</para>
283               </listitem>
284             </varlistentry>
285             <varlistentry>
286               <term>default</term>
287               <listitem>
288                 <para>off</para>
289               </listitem>
290             </varlistentry>
291             <varlistentry>
292               <term>allowed</term>
293               <listitem>
294                 <para>(?:off|login|plain)</para>
295               </listitem>
296             </varlistentry>
297           </variablelist>
298           <para>Specifies the type of SASL Authentication to use</para>
299         </listitem>
300       </varlistentry>
301     </variablelist>
302     <variablelist>
303       <varlistentry>
304         <term>sasl_user</term>
305         <listitem>
306           <variablelist>
307             <varlistentry>
308               <term>required</term>
309               <listitem>
310                 <para>optional</para>
311               </listitem>
312             </varlistentry>
313             <varlistentry>
314               <term>default</term>
315               <listitem>
316                 <para/>
317               </listitem>
318             </varlistentry>
319             <varlistentry>
320               <term>allowed</term>
321               <listitem>
322                 <para>.+</para>
323               </listitem>
324             </varlistentry>
325           </variablelist>
326           <para>The SASL Authentication username</para>
327         </listitem>
328       </varlistentry>
329     </variablelist>
330     <variablelist>
331       <varlistentry>
332         <term>sasl_password</term>
333         <listitem>
334           <variablelist>
335             <varlistentry>
336               <term>required</term>
337               <listitem>
338                 <para>optional</para>
339               </listitem>
340             </varlistentry>
341             <varlistentry>
342               <term>default</term>
343               <listitem>
344                 <para/>
345               </listitem>
346             </varlistentry>
347             <varlistentry>
348               <term>allowed</term>
349               <listitem>
350                 <para>.+</para>
351               </listitem>
352             </varlistentry>
353           </variablelist>
354           <para>The SASL Authentication password</para>
355         </listitem>
356       </varlistentry>
357     </variablelist>
358     <variablelist>
359       <varlistentry>
360         <term>sasl_auth_id</term>
361         <listitem>
362           <variablelist>
363             <varlistentry>
364               <term>required</term>
365               <listitem>
366                 <para>optional</para>
367               </listitem>
368             </varlistentry>
369             <varlistentry>
370               <term>default</term>
371               <listitem>
372                 <para/>
373               </listitem>
374             </varlistentry>
375             <varlistentry>
376               <term>allowed</term>
377               <listitem>
378                 <para>.+</para>
379               </listitem>
380             </varlistentry>
381           </variablelist>
382           <para>The SASL Authorization Identity</para>
383         </listitem>
384       </varlistentry>
385     </variablelist>
386   </section>
387   <example>
388     <title>Send an email to test SMTP service.</title>
389     <para>The following example sends an email via 10.80.117.6 from test@omniti.com to devnull@omniti.com</para>
390     <programlisting>
391       &lt;noit&gt;
392         &lt;modules&gt;
393           &lt;loader image="lua" name="lua"&gt;
394             &lt;config&gt;&lt;directory&gt;/opt/reconnoiter/libexec/modules-lua/?.lua&lt;/directory&gt;&lt;/config&gt;
395           &lt;/loader&gt;
396           &lt;module loader="lua" name="smtp" object="noit.module.smtp"/&gt;
397         &lt;/modules&gt;
398         &lt;checks&gt;
399           &lt;check uuid="2d42adbc-7c7a-11dd-a48f-4f59e0b654d3" module="smtp" target="10.80.117.6"&gt;
400             &lt;config&gt;
401               &lt;from&gt;test@omniti.com&lt;/from&gt;
402               &lt;to&gt;devnull@omniti.com&lt;/to&gt;
403             &lt;/config&gt;
404           &lt;/check&gt;
405         &lt;/checks&gt;
406       &lt;/noit&gt;
407       </programlisting>
408   </example>
409 </section>
Note: See TracBrowser for help on using the browser.