5.16. imap

IMAP metrics check.

loader

lua

object

noit.module.imap

5.16.1. Module Configuration

5.16.2. Check Configuration

port
required

required

allowed

\d+

Specifies the port on which the management interface can be reached.

auth_user
required

required

allowed

.+

The IMAP user.

auth_password
required

required

allowed

.+

The IMAP password.

folder
required

optional

default

INBOX

allowed

.+

The folder that should be examined.

search
required

optional

allowed

.+

Specify an optional IMAP SEARCH operation to execute after EXAMINE

fetch
required

optional

default

false

allowed

(?:true|false|on|off)

Fetch either that highest UID or last SEARCH result.

use_ssl
required

optional

default

false

allowed

^(?:true|false|on|off)$

Upgrade TCP connection to use SSL.

ca_chain
required

optional

allowed

.+

A path to a file containing all the certificate authorities that should be loaded to validat e the remote certificate (for SSL checks).

certificate_file
required

optional

allowed

.+

A path to a file containing the client certificate that will be presented to the remote serv er (for SSL checks).

key_file
required

optional

allowed

.+

A path to a file containing key to be used in conjunction with the cilent certificate (for S SL checks).

ciphers
required

optional

allowed

.+

A list of ciphers to be used in the SSL protocol (for SSL checks).

header_Host
required

optional

allowed

.+

The host header to validate against the SSL certificate (for SSL checks).

Example 5.17. Checking IMAP connection.

This example checks IMAP connection with and without SSL.

      <noit>
        <modules>
          <loader image="lua" name="lua">
            <config><directory>/opt/reconnoiter/libexec/modules-lua/?.lua</directory></config>
          </loader>
          <module loader="lua" name="imap" object="noit.module.imap" />
        </modules>
        <checks>
          <imaps target="10.0.7.2" module="imap" period="10000" timeout="5000">
            <check uuid="79ba881e-ad2e-11de-9fb0-a322e3288ca7" name="imap">
              <config>
                <port>143</port>
                <auth_user>bob</auth_user>
                <auth_password>bob</auth_password>
              </config>
            </check>
            <check uuid="a18659c2-add8-11de-bd01-7ff0e1a67246" name="imaps">
              <config>
                <port>993</port>
                <auth_user>bob</auth_user>
                <auth_password>bob</auth_password>
                <use_ssl>true</use_ssl>
              </config>
            </check>
          </imaps>
        </checks>
      </noit>