ltm monitor tcp-half-open
ltm monitor tcp-half-open(1) BIG-IP TMSH Manual ltm monitor tcp-half-open(1)
NAME
tcp-half-open - Configures a Transmission Control Protocol (TCP) Half Open monitor.
MODULE
ltm monitor
SYNTAX
Configure the tcp-half-open component within the ltm monitor module using the syntax in the following
sections.
CREATE/MODIFY
create tcp-half-open [name]
modify tcp-half-open [name]
options:
app-service [[string] | none]
defaults-from [name]
description [string]
destination [ [ ipv4 address[:port] ] | [ ipv6 address[.port] ] ]
interval [integer]
manual-resume [enabled | disabled]
time-until-up [integer]
timeout [integer]
transparent [disabled | enabled]
up-interval [integer]
edit tcp-half-open [ [ [name] | [glob] | [regex] ] ... ]
options:
all-properties
non-default-properties
DISPLAY
list tcp-half-open
list tcp-half-open [ [ [name] | [glob] | [regex] ] ... ]
show tcp-half-open [ [ [name] | [glob] | [regex] ] ... ]
show running-config tcp-half-open
show running-config tcp-half-open [ [ [name] | [glob] |
[regex] ] ... ]
options:
all-properties
non-default-properties
one-line
partition
test-result
DELETE
delete tcp-half-open [name]
Note: You cannot delete default monitors.
RUN
run tcp-half-open [name] [ destination [ [ ipv4 address[:port] ] | [ ipv6 address[.port] ] ] ]
STOP
stop tcp-half-open [name]
DESCRIPTION
You can use the tcp-half-open component to configure a custom monitor, or you can use the default TCP Half
Open monitor that the Local Traffic Manager provides.
For more information about configuring monitors, refer to the Configuration Guide for BIG-IP(r) Local Traffic
Manager(r).
You can test a custom monitor configuration against a specified target destination by using the run command,
and view the results of such a test by using the show command with the test-result option.
The following user roles (in addition to the root user) have permissions to run and stop an ltm monitor test:
admin, application-editor, manager, operator, resource-admin
EXAMPLES
create tcp-half-open my_tcp-half-open defaults-from tcp_half_open
Creates a monitor named my_tcp-half-open that inherits properties from the default TCP Half Open monitor.
list tcp-half-open
Displays the properties of all of the TCP Half Open monitors.
run tcp-half-open my_tcp-half-open destination 10.10.10.10:80
Runs a one-shot test of the custom monitor my_tcp-half-open against a target node at 10.10.10.10:80.
stop tcp-half-open my_tcp-half-open
Cancels a one-shot test of the custom monitor my_tcp-half-open in progress.
show tcp-half-open my_tcp-half-open test-result
Displays the result of the most recent one-shot test of the custom monitor my_tcp-half-open.
OPTIONS
app-service
Specifies the name of the application service to which the monitor belongs. The default value is none.
Note: If the strict-updates option is enabled on the application service that owns the object, you cannot
modify or delete the monitor. Only the application service can modify or delete the monitor.
defaults-from
Specifies the name of the monitor from which you want your custom monitor to inherit settings. The
default value is tcp_half_open.
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.
This option is required for the command run, unless an IP address and service port are specified in the
destination option for the specified custom monitor.
glob Displays the items that match the glob expression. See help glob for a description of glob expression
syntax.
interval
Specifies, in seconds, the frequency at which the system issues the monitor check when either the
resource is down or the status of the resource is unknown. The default value is 5 seconds.
Important: F5 Networks recommends that when you configure this option and the up-interval option,
whichever value is greater be a multiple of the lesser value to allow for an even distribution of monitor
checks among all monitors.
manual-resume
Specifies whether the system automatically changes the status of a resource to up at the next successful
monitor check. The default value of the manual-resume option is disabled.
Note that if you set the manual-resume option to enabled, you must manually mark the resource as up
before the system can use it for load balancing connections.
name Specifies a unique name for the component. This option is required for the commands create, delete,
modify, run and stop.
partition
Displays the administrative partition within which the component resides.
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.
test-result
Displays the result of the most recent one-shot test of the specified monitor(s), if any such test has
been performed since BIG-IP was started.
time-until-up
Specifies the amount of time, in seconds, after the first successful response before a node is marked up.
A value of 0 (zero) causes a node to be marked up immediately after a valid response is received from the
node. The default value is 0 (zero).
timeout
Specifies the number of seconds the target has in which to respond to the monitor request. The default
value is 16 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.
up-interval
Specifies, in seconds, the frequency at which the system issues the monitor check when the resource is
up. The default value is 0 (zero), which specifies that the system uses the value of the interval option
whether the resource is up or down.
Important: F5 Networks recommends that when you configure this option and the interval option, whichever
value is greater be a multiple of the lesser value to allow for an even distribution of monitor checks
among all monitors.
SEE ALSO
create, delete, edit, glob, list, modify, regex, run, show, stop, 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, 2017. All rights reserved.
BIG-IP 2017-08-16 ltm monitor tcp-half-open(1)