gtm monitor smtp
gtm monitor smtp(1) BIG-IP TMSH Manual gtm monitor smtp(1)
NAME
smtp - Configures a Simple Mail Transport Protocol (SMTP) monitor.
MODULE
gtm monitor
SYNTAX
Configure the smtp component within the gtm monitor module using the syntax in the following sections.
CREATE/MODIFY
create smtp [name]
modify smtp [name]
options:
debug [no | yes]
defaults-from [name]
description [string]
destination [ [ ipv4 address[:port] ] | [ ipv6 address[.port] ] ]
domain [ [name] | none]
ignore-down-response [enabled | disabled]
interval [integer]
probe-timeout [integer]
timeout [integer]
edit smtp [ [ [name] | [glob] | [regex] ] ... ]
options:
all-properties
non-default-properties
DISPLAY
list smtp
list smtp [ [ [name] | [glob] | [regex] ] ... ]
show running-config smtp
show running-config smtp [ [ [name] | [glob] | [regex] ] ... ]
options:
all-properties
non-default-properties
one-line
partition
DELETE
delete smtp [name]
Note: You cannot delete default monitors.
DESCRIPTION
You can use the smtp component to configure a custom monitor, or you can use the default SMTP monitor that the Global
Traffic Manager provides. This type of monitor checks the status of a pool, pool member, or virtual server by issuing
standard SMTP commands.
EXAMPLES
create smtp my_smtp defaults-from smtp
Creates a monitor named my_smtp that inherits properties from the default SMTP monitor.
list smtp
Displays the properties of all of the SMTP 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
smtp.
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.
domain
Specifies the domain name to check, for example, bigipinternal.com. The default value is none.
glob Displays the items that match the glob expression. See help glob for a description of glob expression syntax.
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 30 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.
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 120
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.
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, 2016. All rights reserved.
BIG-IP 2017-08-15 gtm monitor smtp(1)