root/src/modules/http.xml

Revision 9d30fdfc4b9e95f3b7088ef4f7ae9fc89521e0e2, 2.9 kB (checked in by Theo Schlossnagle <jesus@omniti.com>, 6 years ago)

typo correction

  • Property mode set to 100644
Line 
1 <module>
2   <name>http</name>
3   <description><para>The http module performs GET requests over either HTTP or HTTPS and checks the return code.</para>
4   </description>
5   <loader>C</loader>
6   <image>http.so</image>
7   <moduleconfig>
8     <parameter name="url"
9                required="optional"
10                allowed=".+">The default URL to be used by checks that do not specify an explicit URL.</parameter>
11     <parameter name="ca_chain"
12                required="optional"
13                allowed=".+">A path to a file containing all the certificate authorities that should be loaded to validate the remote certificate (for SSL checks).  This is used for SSL checks if this paramter is not set explicitly in the check config.</parameter>
14     <parameter name="certificate_file"
15                required="optional"
16                allowed=".+">A path to a file containing all the client certificate that will be presented to the remote server (for SSL checks).  This is used for SSL checks if this paramter is not set explicitly in the check config.</parameter>
17   </moduleconfig>
18   <checkconfig>
19     <parameter name="url"
20                required="required"
21                allowed=".+">The URL including schema and hostname (as you would type into a browser's location bar).</parameter>
22     <parameter name="ca_chain"
23                required="optional"
24                allowed=".+">A path to a file containing all the certificate authorities that should be loaded to validate the remote certificate (for SSL checks).</parameter>
25     <parameter name="certificate_file"
26                required="optional"
27                allowed=".+">A path to a file containing all the client certificate that will be presented to the remote server (for SSL checks).</parameter>
28     <parameter name="code"
29                required="optional"
30                default="200"
31                allowed="[1-5][0-9][0-9]">The HTTP code that is expected.  If the code received matches this code, the check is marked as "good," if it does not match, it is marked as "bad."</parameter>
32   </checkconfig>
33   <examples>
34     <example>
35       <title>Checking an HTTP and HTTPS URL.</title>
36       <para>This example checks the OmniTI Labs website over both HTTP and HTTPS..</para>
37       <programlisting><![CDATA[
38       <noit>
39         <modules>
40           <module image="http" name="http">
41             <config><ca_chain>/etc/ssl/ca.crt</ca_chain></config>
42           </module>
43         </modules>
44         <checks>
45           <labs target="8.8.38.5" module="http">
46             <check uuid="fe3e984c-7895-11dd-90c1-c74c31b431f0" name="http">
47               <config><url>http://labs.omniti.com/</url></config>
48             </check>
49             <check uuid="1ecd887a-7896-11dd-b28d-0b4216877f83" name="https">
50               <config><url>https://labs.omniti.com/</url></config>
51             </check>
52           </labs>
53         </checks>
54       </noit>
55     ]]></programlisting>
56     </example>
57   </examples>
58 </module>
Note: See TracBrowser for help on using the browser.