5.26. pop3

POP3 metrics check.

loader

lua

object

noit.module.pop3

5.26.1. Module Configuration

5.26.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 POP3 user.

auth_password
required

required

allowed

.+

The POP3 password.

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).

expected_certificate_name
required

optional

allowed

.+

The expected certificate name to validate against the SSL certificate (for SSL checks).

Example 5.27. Checking POP3 connection.

This example checks the POP connection.

      <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.pop3" />
        </modules>
        <checks>
          <check target="10.0.7.2" module="pop3" name="pop3" uuid="79ba881e-ad2e-11de-9fb0-a322e3288ca7" period="10000" timeout="5000">
            <config>
              <port>110</port>
              <auth_user>bob</auth_user>
              <auth_password>bob</auth_password>
              <use_ssl>false</use_ssl>
            </config>
          </check>
        </checks>
      </noit>