IMAP/ IMAPS Health Monitor
Overview
The IMAP (Internet Message Access Protocol) monitor is used for IMAP services. It uses LIST command to get folders present in mail box after issuing CAPA (capabilities) and user authentication.
On successful transfer, IMAP monitor will mark the server up, else it will mark the server down.
When folder is configured it will fetch the first message present in that mailbox folder and after successfully receiving the response from the server, it will mark the server as up else down.
Configuring IMAP Specific Monitor
| Field | Description | Optional/ Mandatory |
|---|---|---|
| Folder | Name of the folder present in mailbox | Optional |
| Username | Mail client username (present under general health monitor configuration under authentication) | Mandatory |
| Password | Mail client password (present under general health monitor configuration under authentication) | Mandatory |
| SSL Attributes | Required for IMAPS (secure IMAP) monitor | Mandatory for IMAPS (SSL Profile Attribute) |
Note: Currently these can be configured only using the CLI.
Configuring Basic IMAP Health Monitor from CLI
This will list the mailboxes present by sending LIST command after CAPA and user authentication.
[admin:avi-controller]: > configure healthmonitor example-basic-imap-hm
[admin:avi-controller]: healthmonitor> type health_monitor_imap
[admin:avi-controller]: healthmonitor> authentication
[admin:avi-controller]: healthmonitor:authentication> username user1
[admin:avi-controller]: healthmonitor:authentication> password jhkjgjgk
[admin:avi-controller]: healthmonitor:authentication> save
[admin:avi-controller]: healthmonitor> save
Configuring IMAPS Health Monitor from CLI
The IMAPS health monitor will fetch first message present in the configured folder after executing CAPA and user authentication over secure channel.
[admin:avi-controller]: > configure healthmonitor example-imaps-hm
[admin:avi-controller]: healthmonitor> type health_monitor_imaps
[admin:avi-controller]: healthmonitor> imaps_monitor
[admin:avi-controller]: healthmonitor:imaps_monitor> folder INBOX
[admin:avi-controller]: healthmonitor:imaps_monitor> ssl_attributes
[admin:avi-controller]: healthmonitor:imaps_monitor:ssl_attributes> ssl_profile_ref System-Standard
[admin:avi-controller]: healthmonitor:imaps_monitor:ssl_attributes> save
[admin:avi-controller]: healthmonitor:imaps_monitor> save
[admin:avi-controller]: healthmonitor> authentication
[admin:avi-controller]: healthmonitor:authentication> username user1
[admin:avi-controller]: healthmonitor:authentication> password kjhkjhjkk
[admin:avi-controller]: healthmonitor:authentication> save
[admin:avi-controller]: healthmonitor> save
The following are the SSL configurations used for IMAPS health monitor.
-
SSL Profile — Select an existing SSL profile or create a new one, as required. This defines the ciphers and SSL versions to be used for the health monitor traffic to the backend servers.
-
PKI Profile — Select an existing PKI profile or create a new one, as required. This will be used as to validate the SSL certificate presented by the server.
-
SSL key and certificate — Select an existing SSL Key and Certificate or create a new one, as required.
Document Revision History
| Date | Change Summary |
|---|---|
| April 15, 2021 | Published IMAP Health Monitor Guide |