ltm monitor mysql
ltm monitor mysql(1) BIG-IP TMSH Manual ltm monitor mysql(1)
NAME
mysql - Configures a MySQL(r) monitor.
MODULE
ltm monitor
SYNTAX
Configure the mysql component within the ltm monitor module using the
syntax in the following sections.
CREATE/MODIFY
create mysql [name]
modify mysql [name]
options:
app-service [[string] | none]
count [integer]
database [ [name] | none]
debug [no | yes]
defaults-from [name]
description [string]
destination [ [ ipv4 address[:port] ] | [ ipv6 address[.port] ] ]
interval [integer]
manual-resume [enabled | disabled]
password [none | [password] ]
recv [none | [string] ]
recv-column [none | [string] ]
recv-row [none | [string] ]
send [none | [string] ]
time-until-up [integer]
timeout [integer]
up-interval [integer]
username [[name] | none]
edit mysql [ [ [name] | [glob] | [regex] ] ... ]
options:
all-properties
non-default-properties
DISPLAY
list mysql
list mysql [ [ [name] | [glob] | [regex] ] ... ]
show mysql [ [ [name] | [glob] | [regex] ] ... ]
show running-config mysql
show running-config mysql [ [ [name] | [glob] | [regex] ] ... ]
options:
all-properties
non-default-properties
one-line
partition
test-result
DELETE
delete mysql [name]
Note: You cannot delete default monitors.
RUN
run mysql [name] [ destination [ [ ipv4 address[:port] ] | [ ipv6 address[.port] ] ] ]
STOP
stop mysql [name]
DESCRIPTION
You can use the mysql component to configure a custom monitor, or you
can use the default MySQL monitor that the Local Traffic Manager
provides. This type of monitor verifies MySQL-based services.
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 mysql my_mysql defaults-from mysql
Creates a monitor named my_mysql that inherits properties from the
default MySQL monitor.
list mysql
Displays the properties of all of the MySQL monitors.
run mysql my_mysql destination 10.10.10.10:80
Runs a one-shot test of the custom monitor my_mysql against a target
node at 10.10.10.10:80.
stop mysql my_mysql
Cancels a one-shot test of the custom monitor my_mysql in progress.
show mysql my_mysql test-result
Displays the result of the most recent one-shot test of the custom
monitor my_mysql.
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.
count
Specifies the number of monitor probes after which the connection
to the database will be terminated. Count value of zero indicates
that the connection will never be terminated. The default value is
zero.
database
Specifies the name of the database with which the monitor attempts
to communicate. The default value is none.
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 mysql.
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.
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 30 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.
password
Specifies the password if the monitored target requires
authentication. The default value is none.
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 a field in your database. If you do not specify a
value for both the send and recv options, the monitor performs a
simple service check and connect only.
recv-column
Specifies the column in the database where the system expects the
specified Receive String to be located. Specify this option only
if you configure the send and recv options. The default value is
none.
recv-row
Specifies the row in the database where the system expects the
specified Receive String to be located. Specify this option only
if you configure the send and recv options. The default value is
none.
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.
send Specifies the SQL query that the monitor sends to the target
database, for example, SELECT count(*) FROM mytable.
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.
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 91 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.
username
Specifies the username, if the monitored target requires
authentication. The default value is none.
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 2009-2010, 2012-2014, 2017. All
rights reserved.
BIG-IP 2017-08-16 ltm monitor mysql(1)