gtm monitor imap
gtm monitor imap(1) BIG-IP TMSH Manual gtm monitor imap(1)
NAME
imap - Configures an Internet Message Access Protocol (IMAP) monitor.
MODULE
gtm monitor
SYNTAX
Configure the imap component within the gtm monitor module using the syntax in the following sections.
CREATE/MODIFY
create imap [name]
modify imap [name]
options:
debug [no | yes]
defaults-from [name]
description [string]
destination [ [ ipv4 address[:port] ] | [ ipv6 address[.port] ] ]
folder [ [name] | none]
ignore-down-response [enabled | disabled]
interval [integer]
password [none | [password] ]
probe-timeout [integer]
timeout [integer]
transparent [enabled | disabled]
username [ [name] | none]
edit imap [ [ [name] | [glob] | [regex] ] ... ]
options:
all-properties
non-default-properties
DISPLAY
list imap
list imap [ [ [name] | [glob] | [regex] ] ... ]
show running-config imap
show running-config imap [ [ [name] | [glob] | [regex] ] ... ]
options:
all-properties
non-default-properties
one-line
partition
DELETE
delete imap [name]
Note: You cannot delete default monitors.
DESCRIPTION
You can use the imap component to configure a custom monitor, or you can use the default IMAP monitor that the
Global Traffic Manager provides. This type of monitor verifies IMAP by attempting to open a specified mail
folder on a server. This monitor is similar to the POP3 monitor.
EXAMPLES
create imap my_imap defaults-from imap
Creates a monitor named my_imap that inherits properties from the default IMAP monitor.
list imap
Displays the properties of all of the IMAP monitors.
OPTIONS
debug
Specifies whether the monitor sends error messages and additional information to a log file created and
labeled specifically for this monitor. You can use the log information to help diagnose and troubleshoot
unsuccessful health checks.
The default value is no. The options are:
no Specifies that the system does not redirect error messages and additional information related to
this monitor.
yes Specifies that the system redirects error messages and additional information to the
/var/log/monitors/--.log file.
defaults-from
Specifies the name of the monitor from which you want your custom monitor to inherit settings. The
default value is imap.
description
User defined description.
destination
Specifies the IP address and service port of the resource that is the destination of this monitor. The
default value is *:*.
Possible values are:
*:* Specifies to perform a health check on the IP address and port supplied by a pool member.
*:port
Specifies to perform a health check on the server with the IP address supplied by the pool member
and the port you specify.
IP address:port
Specifies to mark a pool member up or down based on the response of the server at the IP address and
port you specify.
glob Displays the items that match the glob expression. See help glob for a description of glob expression
syntax.
folder
Specifies the name of the folder on the IMAP server that the monitor tries to open. The default value is
INBOX.
ignore-down-response
Specifies whether the monitor ignores a down response from the system it is monitoring. The default value
is disabled.
interval
Specifies the frequency at which the system issues the monitor check. The default value is 10 seconds.
name Specifies a unique name for the component. This option is required for the commands create, delete, and
modify.
partition
Displays the administrative partition within which the component resides.
password
Specifies the password if the monitored target requires authentication. The default value is none.
probe-timeout
Specifies the number of seconds after which the BIG-IP(r) system times out the probe request to the BIG-
IP system. The default value is 5 seconds.
regex
Displays the items that match the regular expression. The regular expression must be preceded by an at
sign (@[regular expression]) to indicate that the identifier is a regular expression. See help regex for
a description of regular expression syntax.
timeout
Specifies the number of seconds the target has in which to respond to the monitor request. The default
value is 31 seconds.
If the target responds within the set time period, it is considered up. If the target does not respond
within the set time period, it is considered down. Also, if the target responds with a RESET packet, the
system immediately flags the target as down without waiting for the timeout interval to expire.
transparent
Specifies whether the monitor operates in transparent mode. Monitors in transparent mode can monitor pool
members through firewalls. The default value is disabled.
username
Specifies the username, if the monitored target requires authentication. The default value is none.
SEE ALSO
create, delete, edit, glob, gtm pool, list, modify, regex, show, tmsh
COPYRIGHT
No part of this program may be reproduced or transmitted in any form or by any means, electronic or
mechanical, including photocopying, recording, or information storage and retrieval systems, for any purpose
other than the purchaser's personal use, without the express written permission of F5 Networks, Inc.
F5 Networks and BIG-IP (c) Copyright 2008-2010, 2013-2014. All rights reserved.
BIG-IP 2017-08-15 gtm monitor imap(1)