gtm monitor tcp
gtm monitor tcp(1) BIG-IP TMSH Manual gtm monitor tcp(1)
NAME
tcp - Configures a Transmission Control Protocol (TCP) monitor.
MODULE
gtm monitor
SYNTAX
Configure the tcp component within the gtm monitor module using the
syntax in the following sections.
CREATE/MODIFY
create tcp [name]
modify tcp [name]
options:
defaults-from [name]
description [string]
destination [ [ ipv4 address[:port] ] | [ ipv6 address[.port] ] ]
ignore-down-response [enabled | disabled]
interval [integer]
probe-timeout [integer]
recv [none | [string] ]
reverse [enabled | disabled]
send [none | [string] ]
timeout [integer]
transparent [disabled | enabled]
edit tcp [ [ [name] | [glob] | [regex] ] ... ]
options:
all-properties
non-default-properties
DISPLAY
list tcp
list tcp [ [ [name] | [glob] | [regex] ] ... ]
show running-config tcp
show running-config tcp [ [ [name] | [glob] | [regex] ] ... ]
options:
all-properties
non-default-properties
one-line
partition
DELETE
delete tcp [name]
Note: You cannot delete default monitors.
DESCRIPTION
You can use the tcp component to configure a custom monitor, or you can
use the default TCP monitor that the Global Traffic Manager provides.
EXAMPLES
create tcp my_tcp defaults-from tcp
Creates a monitor named my_tcp that inherits properties from the
default TCP monitor.
list tcp
Displays the properties of all of the TCP monitors.
OPTIONS
defaults-from
Specifies the name of the monitor from which you want your custom
monitor to inherit settings. The default value is tcp.
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.
IP address:port (with the transparent option enabled)
Specifies to perform a health check on the server at the IP
address and port you specify, route the check through the IP
address and port supplied by the pool member, and mark the
pool member (the gateway) up or down accordingly.
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.
recv Specifies the text string that the monitor looks for in the
returned resource. The default value is none.
The most common receive expressions contain a text string that is
included in an HTML file on your site. The text string can be
regular text, HTML tags, or image names. If you do not specify a
value for both the send and recv options, the monitor performs a
simple service check and connect only.
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.
reverse
Specifies whether the monitor operates in reverse mode. When the
monitor is in reverse mode, a successful check marks the monitored
object down instead of up. You can use the this mode only if you
configure both the send and recv options.
The default value is disabled, which specifies that the monitor
does not operate in reverse mode. The enabled value specifies that
the monitor operates in reverse mode.
send Specifies the text string that the monitor sends to the target
object. The default setting is GET /, which retrieves a default
HTML file for a web site.
To retrieve a specific page from a web site, specify a fully-
qualified path name, for example, GET /www/company/index.html.
Since the string may have special characters, the system may
require that the string be enclosed with single quotation marks.
If this value is null, then a valid connection suffices to
determine that the service is up. In this case, the system does
not need the recv option and ignores the option even if not null.
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.
transparent
Specifies whether the monitor operates in transparent mode.
Monitors in transparent mode can monitor pool members through
firewalls. The default value is disabled.
SEE ALSO
create, delete, edit, glob, gtm pool, gtm server, 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, 2012-2013. All rights
reserved.
BIG-IP 2017-08-15 gtm monitor tcp(1)