ltm monitor external
ltm monitor external(1) BIG-IP TMSH Manual ltm monitor external(1)
NAME
external - Configures an external monitor.
MODULE
ltm monitor
SYNTAX
Configure the external component within the ltm monitor module using
the syntax in the following sections.
CREATE/MODIFY
create external [name]
modify external [name]
options:
args [ [arguments] | none]
app-service [[string] | none]
defaults-from [name]
description [string]
destination [ip address][port]
interval [integer]
manual-resume [enabled | disabled]
run [none | [path] ]
time-until-up [integer]
timeout [integer]
user-defined [ [name] [value] | [name] none ]
up-interval [integer]
edit external [ [ [name] | [glob] | [regex] ] ... ]
options:
all-properties
non-default-properties
DISPLAY
list external
list external [ [ [name] | [glob] | [regex] ] ... ]
show external [ [ [name] | [glob] | [regex] ] ... ]
show running-config external
show running-config external [ [ [name] | [glob] | [regex] ] ... ]
options:
all-properties
non-default-properties
one-line
partition
DELETE
delete external [name]
Note: You cannot delete default monitors.
DESCRIPTION
You can use the external component to configure a custom monitor, or
you can use the default external monitor that the Local Traffic Manager
provides. Using this type of monitor, you can use your own programs to
monitor services.
EXAMPLES
create external my_external defaults-from external
Creates a monitor named my_external that inherits properties from the
default external monitor.
list external
Displays the properties of all of the external monitors.
OPTIONS
args Specifies any command-line arguments that the external program
requires. The default value is none.
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 external.
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 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.
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, and modify.
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.
run Specifies the path and file name of a program to run as the
external monitor, for example /config/monitors/myMonitor. The
default value is none.
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.
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.
user-defined
Specifies any user-defined command-line arguments and variables
that the external program requires. Use the following syntax to
specify a user defined parameter.
modify external my_external user-defined my_param_name
my_param_value
Use the following syntax to remove a user defined parameter.
modify external my_external user-defined my_param_name none
SEE ALSO
create, delete, edit, glob, 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. All rights
reserved.
BIG-IP 2013-09-10 ltm monitor external(1)